Wie wird eine Warnung ausgegeben, wenn der Rückgabewert nicht beachtet wird?

Question

Ich möchte alle Orte in meinem Code (C++) sehen, die den Rückgabewert einer Funktion ignorieren. Wie kann ich es tun - mit GCC oder statischen Code-Analyse-Tool?

Bad Codebeispiel:

int f(int z) { 
    return z + (z*2) + z/3 + z*z + 23; 
} 


int main() 
{ 
    int i = 7; 
    f(i); ///// <<----- here I disregard the return value 

    return 1; 
} 

Bitte beachten Sie, dass:

• es funktionieren soll, auch wenn die Funktion und ihre Verwendung ist in verschiedenen Dateien
• kostenlos statische Überprüfung Werkzeug

Answer 1

Sie wollen warn_unused_result Attribut des GCC:

#define WARN_UNUSED __attribute__((warn_unused_result)) 

int WARN_UNUSED f(int z) { 
    return z + (z*2) + z/3 + z*z + 23; 
} 

int main() 
{ 
    int i = 7; 
    f(i); ///// <<----- here i disregard the return value 
    return 1; 
} 

Der Versuch, diesen Code zu kompilieren erzeugt:

$ gcc test.c 
test.c: In function `main': 
test.c:16: warning: ignoring return value of `f', declared with 
attribute warn_unused_result 

du in der Linux kernel im Einsatz sehen können; sie haben einen __must_check Makro, der das Gleiche macht; sieht so aus, als müssten Sie GCC 3.4 oder höher verwenden, damit dies funktioniert. Dann finden Sie das in Kernel-Header-Dateien verwendete Makro:

Answer 2

Jeder statische Analysecode (z.B. PC-Lint) sollte Ihnen das sagen können. Für PC-Lint weiß ich, dass dies der Fall ist.

Answer 3

ein statischer Analysator die Arbeit für Sie tut, aber wenn Ihre Code-Basis mehr als trivial ist vorbereitet ;-)

Answer 4

Was überwältigt werden, wie ich ihm bewusst bin, ist keine GCC Möglichkeit, diese Warnung zu geben . Wenn Sie jedoch in bestimmten Funktionen interessiert sind, können Sie sie mit einem Attribut markieren:

int fn() __attribute__((warn_unused_result)); 

die eine Warnung geben würde, wenn der Rückgabewert von fn() nicht verwendet wurde. Vorbehalt: Ich habe dieses Feature nie selbst benutzt.

Answer 5

Ein statischer Analysator ist hier die beste Wahl. Wir verwenden Coverity hier, aber es gibt free tools verfügbar, die Sie auch verwenden können.

Wenn Sie eine schnelle und unsaubere Lösung benötigen und Sie haben ein Linux-basiert Shell handlich, können Sie so etwas wie versuchen:

grep -rn "function_name" * | grep -v "=" 

, dass jede Zeile finden, die die angegebene Funktion verweist aber nicht enthält ein "=". Sie können viele falsche Positive (und möglicherweise einige falsche Negative) erhalten, aber wenn Sie kein statisches Analysegerät haben, ist es ein guter Ausgangspunkt.

Answer 6

Sie können diese praktische Vorlage zur Laufzeit verwenden.

Anstatt einen Fehlercode (z. B. HRESULT) zurückzugeben, geben Sie einen return_code <HRESULT> zurück, der behauptet, wenn es den Gültigkeitsbereich verlässt, ohne dass der Wert gelesen wird. Es ist kein statisches Analysewerkzeug, aber trotzdem nützlich.

class return_value 
{ 
public: 
    explicit return_value(T value) 
    :value(value), checked(false) 
    { 
    } 

    return_value(const return_value& other) 
    :value(other.value), checked(other.checked) 
    { 
    other.checked = true; 
    } 

    return_value& operator=(const return_value& other) 
    { 
    if(this != &other) 
    { 
     assert(checked); 
     value = other.value; 
     checked = other.checked; 
     other.checked = true; 
    } 
    } 

    ~return_value(const return_value& other) 
    { 
    assert(checked); 
    } 

    T get_value()const { 
    checked = true; 
    return value; 
    } 

private: 
    mutable bool checked; 
    T value; 
}; 

class return_value 
{ 
public: 
    explicit return_value(T value) 
    :value(value), checked(false) 
    { 
    } 

    return_value(const return_value& other) 
    :value(other.value), checked(other.checked) 
    { 
    other.checked = true; 
    } 

    return_value& operator=(const return_value& other) 
    { 
    if(this != &other) 
    { 
     assert(checked); 
     value = other.value; 
     checked = other.checked; 
     other.checked = true; 
    } 
    } 

    ~return_value(const return_value& other) 
    { 
    assert(checked); 
    } 

    T get_value()const { 
    checked = true; 
    return value; 
    } 

private: 
    mutable bool checked; 
    T value; 
}; 

Answer 7

Das klassische "Flusen" -Programm war früher sehr viel über Funktionen, die einen Wert zurückgaben, der ignoriert wurde. Das Problem war, dass viele dieser Warnungen unerwünscht waren - was zu übermäßigem Rauschen in der Flusenausgabe führte (es nahm Flusen auf, die man ignorieren wollte). Das ist wahrscheinlich der Grund, warum GCC keine Standardwarnung dafür hat.

Das andere Problem - die Kehrseite - ist "Wie unterdrücken Sie die Warnung, wenn Sie wissen, dass Sie das Ergebnis ignorieren, aber wirklich egal". Das klassische Szenario dafür ist:

if (signal(SIGHUP, SIG_IGN) != SIG_IGN) 
    signal(SIGHUP, sighandler); 

Sie interessieren sich für das erste Ergebnis von signal(); Sie wissen, dass die zweite SIG_IGN sein wird (da Sie es nur darauf eingestellt haben). Um weg von den Warnungen, benutze ich manchmal eine Variante auf:

if ((old = signal(SIGHUP, SIG_IGN)) != SIG_IGN) 
    old = signal(SIGHUP, sighandler); 

Dies ordnet old beiden Male. Sie können das mit 'assert (old == SIG_IGN)' verfolgen.