Znajdowanie i modyfikowanie definicji funkcji (C++) za pomocą skryptu bash

Question

Obecnie pracuję nad dość dużym projektem. Aby podnieść jakość naszego kodu, zdecydowaliśmy się na egzekwowanie wartości zwracanych (Kody błędów) dla każdej funkcji. GCC obsługuje ostrzeżenie dotyczące zwracanej wartości funkcji, jednak definicja funkcji musi być poprzedzona następującą flagą.

static __attribute__((warn_unused_result)) ErrorCode test() { /* code goes here */ } 

Chcę zaimplementować bashscript który analizuje cały kod źródłowy i wysyła ostrzeżenie w przypadku

__attribute__((warn_unused_result)) 

brakuje. Należy pamiętać, że wszystkie funkcje wymagające tego rodzaju modyfikacji zwracają typ o nazwie ErrorCode. Czy myślisz, że jest to możliwe za pośrednictwem skryptu bash?

Answer 1

W prosty sposób mogę sobie wyobrazić, za pośrednictwem ctags. Utwórz plik znacznika na całym kodzie źródłowym, a następnie przeanalizuj plik znaczników. Jednak nie jestem pewien co do formatu pliku znaczników. Wariant, którego tu używam (Exuberant Ctags 5.8) wydaje się umieszczać "f" w czwartej kolumnie, jeśli znacznik reprezentuje funkcję. Tak więc w tym przypadku użyłbym awk do filtrowania wszystkich znaczników reprezentujących funkcje, a następnie grep, aby wyrzucić wszystkie wiersze bez __attribute__((warn_unused_result)).

Tak, w skrócie, najpierw zrobić

$ ctags **/*.c 

To tworzy plik o nazwie „znaczniki” w bieżącym katalogu. Polecenie może być również ctags-exuberant, w zależności od Twojego wariantu. **/*.c to wzór globalny, który może działać w twojej powłoce - jeśli nie, musisz dostarczyć swoje pliki źródłowe w inny sposób (spójrz na opcje ctags).

Następnie filtrować Funktions:

$ cat tags | awk -F '\t' '$4 == "f" {print $0}' | grep -v "__attribute__((warn_unused_result))" 

Answer 2

Nie, nie jest to możliwe w ogólnym przypadku. Gramatyka C++ jest najbardziej złożonym ze wszystkich języków, jakie znam, a C++ nie jest parsowalny poprzez wyrażenia regularne w ogólnym przypadku. Możesz odnieść sukces, jeśli ograniczysz się do bardzo wąskiego zestawu zastosowań, ale nie jestem pewien, jak to możliwe w twoim przypadku. Nie sądzę, że wysiłek jest wart wysiłku, ponieważ czasami ignorowanie wyniku działania jest OK.

Answer 3

Być może możesz użyć sed z wyrażeń regularnych. Następujące pracował dla mnie na kilka plików testowych próbowałem:

sed -r "s/ErrorCode\s+\w+\s*(.*)\s*\{/__attribute__((warn_unused_result)) \0/g" test.cpp 

Jeśli nie jesteś zaznajomiony z regex, wzór zasadniczo przekłada się na:

errorCode jakieś odstępy, niektóre znaki alfanumeryczne (nazwa funkcji), może jakiś biały spacja, otwarty nawias, cokolwiek (argumenty), bliski nawias, może jakiś biały, otwarty nawias klamrowy.

Jeśli ten wzór zostanie znaleziony, zostanie poprzedzony prefiksem __attribute__((warn_unused_result)). Zauważ, że działa to tylko wtedy, gdy wstawiasz nawias klamrowy zawsze w tym samym wierszu, co argumenty, i nie masz linii podziału w deklaracjach funkcji.