Discussion :

[_iri_]

Bonjour,

J'ai des milliers de lignes de code en langage C sur des dizaines de fichiers écrits par des tiers (je ne peux aller leur demander).
L'immense majorité des commentaires sont en // ... sur une ligne ce qui n'est pas standard dans le C que nous utilisons.
Je souhaiterais donc les remplacer par un classique bloc de commentaires entre /* ... */

Exemple :

Code c :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
// Fonction main du programme
int main ()
{
    printf("Hello world!\n");  // ecrit Hello World! dans la console
    return 0;  // valeur retournee par le programme // 0 : succes
}
// Fin du code

Je souhaite avoir :

Code c :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
/* Fonction main du programme */
int main ()
{
    printf("Hello world!\n");  /* ecrit Hello World! dans la console */
    return 0;  /* valeur retournee par le programme // 0 : succes */
}
/* Fin du code */

Remarque : les // qui suivent sur une même ligne sont ignorés (cf exemple ci-dessus)

Un script Bash doit être faisable pour automatiser ce genre de traitement. Je ne dois pas être le premier, je suppose que cela existe déjà quelque part. Je ne voudrais pas perdre du temps à réinventer la roue surtout que je ne suis pas un pro dans ce domaine. Donc si l'un de vous a un script de ce genre, je lui en serais reconnaissant.

[zipe31]

Salut,

Avec "sed" ?

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
$ cat plop
// Fonction main du programme
int main ()
{
    printf("Hello world!\n");  // ecrit Hello World! dans la console
    return 0;  // valeur retournee par le programme // 0 : succes
}
// Fin du code

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
$ cat script.sed 
\#^//# {
s##/*#
s#$# */#
}
s#^\([^/]*\)//\(.*\)$#\1 /* \2 */#

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
$ sed -f script.sed plop 
/* Fonction main du programme */
int main ()
{
    printf("Hello world!\n");   /*  ecrit Hello World! dans la console */
    return 0;   /*  valeur retournee par le programme // 0 : succes */
}
/* Fin du code */

[_iri_]

Merci ! Je testerais cela demain.

[Flodelarab]

Bonjour

L'opération peut être faite en deux temps:

1. On remplace // par /* et */ en fin de ligne
2. On regroupe les lignes qui se suivent dont la première finit par */ et la deuxième commence par /*

Concrètement, sed est le bon outil:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

sed -n 's@//\(.*\)@/*\1*/@;H;${g;s@\*/\n/\*@\n@g;s@\n@@p' fichiers

Si cette commande est satisfaisante, il faut rajouter l'option -i pour que le fichier original soit modifié directement.

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

sed -ni 's@//\(.*\)@/*\1*/@;H;${g;s@\*/\n/\*@\n@g;s@\n@@p' fichiers

Exemple:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
$ cat monfichier
// Fonction main du programme 
int main () 
{
     printf("Hello world!\n");  // ecrit Hello World! dans la console
     return 0;  // valeur retournee par le programme // 0 : succes 
 
//test
//en
//plus
 
} 
// Fin du code
$ sed -n 's@//\(.*\)@/*\1*/@;H;${g;s@\*/\n/\*@\n@g;s@\n@@p}' monfichier
/* Fonction main du programme */
int main () 
{
     printf("Hello world!\n");  /* ecrit Hello World! dans la console*/
     return 0;  /* valeur retournee par le programme // 0 : succes */
 
/*test
en
plus*/
 
} 
/* Fin du code*/
$ sed -ni 's@//\(.*\)@/*\1*/@;H;${g;s@\*/\n/\*@\n@g;s@\n@@p}' monfichier
$ cat monfichier
/* Fonction main du programme */
int main () 
{
     printf("Hello world!\n");  /* ecrit Hello World! dans la console*/
     return 0;  /* valeur retournee par le programme // 0 : succes */
 
/*test
en
plus*/
 
} 
/* Fin du code*/

Il ne reste qu'à espérer que des "//" ne se balladent pas au milieu du code sans être des commentaires.

[Flodelarab]

Arf! Doublement grillé!

[zipe31]

Des fois j'suis c*n, on va faire plus simple

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
$ sed 's#^//\|//\(.*\)$#/* \1 */#' plop 
/*  Fonction main du programme */
int main ()
{
    printf("Hello world!\n");  /*  ecrit Hello World! dans la console */
    return 0;  /*  valeur retournee par le programme // 0 : succes */
}
/*  Fin du code */

[_iri_]

Il ne reste qu'à espérer que des "//" ne se balladent pas au milieu du code sans être des commentaires.

En fait, le point peut être le plus important est de ne surtout pas remplacer un // qui serait inclus dans un // précédent (sur la même ligne donc)

Le premier // sur une ligne => /*
et à la fin de cette ligne, juste avant le saut de ligne, un */

C'est peut-être plus clair dit ainsi

[zipe31]

En fait, le point peut être le plus important est de ne surtout pas remplacer un // qui serait inclus dans un // précédent (sur la même ligne donc)

Le premier // sur une ligne => /*
et à la fin de cette ligne, juste avant le saut de ligne, un */

C'est peut-être plus clair dit ainsi

En fait c'est bien ce que fait ma dernière syntaxe

On cherche 2 // en début de ligne OU les 2 premiers que l'on rencontre, puis on récupère tout ce qui suit jusqu'à la fin de la ligne et on entoure le tout avec des /* ... */

[Flodelarab]

Oui mais zipe31, si la ligne commence par //, ce sont bien les deux premiers que tu renconcontres. Je ne vois pas pourquoi tu fais deux cas.

Quand aux // en plein milieu, je pensais plus à un truc du genre:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

cout<<"///////Au secours ////////";

Auquel cas, il n'y a pas de commentaires.

[disedorgue]

Bonjour,

Euh, cout<<... c'est du c++ pas du c

Bon, après une petite recherche sur le net:
http://www.lrdev.com/lr/c/ccomment.html
Celui-ci propose un petit programme en C (qui se compile très facilement avec gcc):

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

$ gcc ccomment.c -o ccomment

et ensuite pour l'utilisation:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
$ cat te.c
// Fonction main du programme
int main ()
{
    printf("Hello world!\n");  // ecrit Hello World! dans la console
    printf("//////Hello world!\n//////");  // ecrit Hello World! dans la console
    return 0;  // valeur retournee par le programme // 0 : succes
}
// Fin du code

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
$ ./ccomment <te.c
/* Fonction main du programme */
int main ()
{
    printf("Hello world!\n");  /* ecrit Hello World! dans la console */
    printf("//////Hello world!\n//////");  /* ecrit Hello World! dans la console */
    return 0;  /* valeur retournee par le programme // 0 : succes */
}
/* Fin du code */

[zipe31]

Oui mais zipe31, si la ligne commence par //, ce sont bien les deux premiers que tu renconcontres. Je ne vois pas pourquoi tu fais deux cas.

C'est clair, je m'en suis rendu compte en allant me coucher en y repensant après coup. Ça m'arrive souvent au départ en posant les conditions (en début de ligne OU en milieu) et de rester sur cette idée.

Mais bon, hier soir apparemment, il était temps que j'aille retrouver Morphée

Merci

[_iri_]

Bonjour,

Merci pour vos contributions

- La solution proposée par disedorgue, à savoir ccomment, ne fonctionne pas. Je suppose que c'est un problème d'encodage des fichiers (ils sont en ISO-8859-1x ). Si je crée un fichier en UTF-8 avec le même code, c'est ok. Si je fais une conversion des fichiers existants en UTF-8, le résultat reste faux.

Code original :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
/* 
  Ceci est un programme de test
  pour remplacer les commentaires C++
  en commentaires C
*/
// Fonction main du programme
// C est aussi la fonction de test
int main ()
{
    printf("Hello world!\n");  // ecrit Hello World! dans la console
    return 0;  // valeur retournee par le programme // 0 : succes
}
// Fin du code

Code résultant, faux :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
/* 
  Ceci est un programme de test
  pour remplacer les commentaires C++
  en commentaires C
*/
*/ Fonction main du programme
*/ C est aussi la fonction de test
int main ()
{
    printf("Hello world!\n");  /* ecrit Hello World! dans la console*/
    return 0;  /* valeur retournee par le programme // 0 : succes*/
}
/*Fin du code*/

- La solution proposée par zipe31, à savoir :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

sed 's#^//\|//\(.*\)$#/* \1 */#'

me retourne le même résultat que précédemment. Problème d'encodage des fichiers originaux aussi ?

- La solution proposée Flodelarab, à savoir

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

sed -ni 's@//\(.*\)@/*\1*/@;H;${g;s@\*/\n/\*@\n@g;s@\n@@p}'

fonctionne bien a priori.
Cependant, le résultat obtenu est le suivant :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
/* 
  Ceci est un programme de test
  pour remplacer les commentaires C++
  en commentaires C
*/
/* Fonction main du programme
 C est aussi la fonction de test
*/
int main ()
{
    printf("Hello world!\n");  /* ecrit Hello World! dans la console*/
    return 0;  /* valeur retournee par le programme // 0 : succes*/
}
/*Fin du code*/

Je souhaiterais savoir si la conversion de

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
// Fonction main du programme
// C est aussi la fonction de test

en

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
/* Fonction main du programme
 C est aussi la fonction de test
*/

est voulue ou s'il s'agit d'un effet de bord involontaire ?
Dans le premier cas, c'est très bien, dans le second, faudrait voir à ce qu'il n'y ait pas d'autres imprévus

Le tout est sur un svn, je peux donc revenir en arrière le cas échéant, mais je préfère travailler proprement ...

[disedorgue]

C'est bien voulu dans l'expression, ce n'est pas un effet de bord.
La partie qui fais ceci est s@\*/\n/\*@\n@g

[Flodelarab]

• C'est voulu. C'est le deuxième temps expliqué plus haut. Sinon zipe31, et moi avions la même solution.
• Tes fichiers viennent probablement d'un windows. Les fins de ligne sont différentes et il y a un caractère non imprimé.
  Voilà pourquoi le bloc /* */ n'est pas regroupé avec le second bloc /* */.
  Et le second bloc /* */ provient des //, // et // qui sont regroupés car le caractère non visible a été considdéré comme un caractère normal (donc englobé dans le commentaire).
  
  Pour verifier cela,

  Code :

  Sélectionner tout - Visualiser dans une fenêtre à part

  od -c monfichier

• Il serait peut-être plus sage de supprimer ce caractère superflu d'abord. Avec dos2unix monfichier (si je me souviens bien) ou alors sed -i 's/\x0d$//' monfichier

[_iri_]

Renseignements pris, ils sont bien tous d'origine Windows. Cependant, il serait intéressant de garder le CRLF (\r\n) de Windows ...

Est-ce embêtant ?

Par ailleurs :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

printf("/////Hello world!\n//////");  // ecrit Hello World! dans la console

est remplacé en

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

printf("/*////Hello world!\n//////");  // ecrit Hello World! dans la console*/

Merci pour vos explications détaillées, ce type de commande est toujours un émerveillement à voir à l'oeuvre !


Si je peux me permettre une question subsidiaire, j'ai tenté un find -exec sans succès. Pour ma culture personnelle, comment faire ?
Plutôt que mon candide :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
#!/bin/bash
 
ListFiles="$(find *.c -type f)"
for Files in ${ListFiles}; do
	sed -ni 's@//\(.*\)@/*\1*/@;H;${g;s@\*/\n/\*@\n@g;s@\n@@p}' $Files
done

[Flodelarab]

• Proposition:
  
  1. On enlève les CR
  2. On traite
  3. On remet les CR
• La ligne de commande sed devient indigeste. Mettons cela dans un fichier texte executable.
  Le code d'un nouveau fichier texte transformation_commentaires.bash :
  

  Code :

  Sélectionner tout - Visualiser dans une fenêtre à part

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  #!/bin/bash 
   
  sed -ni '
   
  s/\x0d$//
   
  s@//\(.*\)@/*\1*/@
  H
  ${
          g
          s@\*/\n/\*@\n@g
          s@\n@@
   
          s@\n@\x0d\n@g
   
          p
  }
  ' $*

  Droits en executable:

  Code :

  Sélectionner tout - Visualiser dans une fenêtre à part

  chmod +x transformation_commentaires.bash

  Utilisation:

  Code :

  Sélectionner tout - Visualiser dans une fenêtre à part

  ./transformation_commentaires.bash monfichier

• Pour le find, on fait un truc du genre:
  

  Code :

  Sélectionner tout - Visualiser dans une fenêtre à part

  find . -iname "*.c" -type f -exec ./transformation_commentaires.sed {} \;

  Je ne suis pas persuadé que préciser -type f soit nécessaire mais je laisse comme c'est.
  
  NB: pour le find, il faut toujours commencer par indiquer le dossier dans lequel chercher.

[zipe31]

Si je puis me permettre, il vaudrait mieux remplacer s@//\(.*\)@/*\1*/@ par sed 's@//\(.*\)@/* \1 */@' pour éviter les désagréments causés par une multitude de slashs

L'exemple en entrée (donnée par _iri_ ) :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
$ echo "${A}
${B}" 
printf("/////Hello world!\n//////");  // ecrit Hello World! dans la console
// Fin du code

L'exemple en sortie sans espace :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
$ echo "${A}
${B}" | sed 's@//\(.*\)@/* \1 */@'
printf("/* ///Hello world!\n//////");  // ecrit Hello World! dans la console */
/*  Fin du code */

L'exemple en sortie avec espace :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
$ echo "${A}
${B}" | sed 's@// \(.*\)@/* \1 */@'
printf("/////Hello world!\n//////");  /* ecrit Hello World! dans la console */
/* Fin du code */

@Flodelarab : D'ailleurs tu vois, avant d'en arriver là, j'ai encore recommencé avec 's#\(^// \| // \)\(.*\)#/* \2 */#'
Je suis vraiment indécrottable

@ _iri_ : Tous les fichiers à traiter sont dans le même répertoire ou aussi dans des sous-répertoires ?
Parce que si dans un seul, sed peut traiter tous les fichiers à la fois : sed -i 'syntaxe' *.c

[_iri_]

sur un code original :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
/* 
  Ceci est un programme de test
  pour remplacer les commentaires C++
  en commentaires C
*/
// Fonction main du programme
// C est aussi la fonction de test
int main ()
{
    printf("Hello world!\n");  // ecrit Hello World! dans la console
    printf("/////Hello world!\n//////");  // ecrit Hello World! dans la console
    return 0;  // valeur retournee par le programme // 0 : succes
}
// Fin du code

la version mixée Flodelarab * zipe31 fonctionne à merveille (j'ai créé plusieurs fichiers avec de petites modifications à chaque fois)

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
#!/bin/bash
 
sed -ni '
 
s/\x0d$//
 
s#\(^// \| // \)\(.*\)#/* \2 */#
H
${
        g
        s@\*/\n/\*@\n@g
        s@\n@@
 
        s@\n@\x0d\n@g
 
        p
}
' $*

@zipe31
la commande s@//\(.*\)@/* \1 */@ ne va pas (même sortie erronée) en revanche, contrairement à votre première idée s#\(^// \| // \)\(.*\)#/* \2 */#

@ _iri_ : Tous les fichiers à traiter sont dans le même répertoire ou aussi dans des sous-répertoires ?

aussi dans des sous-répertoires

[Flodelarab]

D'abord, il faut comprendre qu'aucune des solutions n'est parfaite.

Ensuite, existe-t-il des fichiers qui ont un commentaire en "//" sans "// " ? Pour le savoir, il suffit de taper la commande de filtre suivante:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

find . -iname "*.c" -type f -exec grep "//" {} \; | grep -v "// "

Si elle ne retourne rien, la syntaxe avec l'espace fonctionne. Sinon, elle retourne les lignes pour lequelles un problème peut apparaitre.

Space or not space, that is the question...


Enfin, find fait une récursion dans les sous-dossiers que ne fait pas le caractère joker *


PS: Personnellement, je regrette que la méthode proposée par disedorgue n'ait pas abouti.

[_iri_]

PS: Personnellement, je regrette que la méthode proposée par disedorgue n'ait pas abouti.

Mais oui, je l'avais un peu oublié celui-là

Il fonctionne très bien pour peu que je fasse les conversions CRLF LF CRLF

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
#!/bin/bash
 
ListFiles="$(find . -iname "*.c" -type f)"
for Files in ${ListFiles}; do
    # convert CRLF -> LF
    sed -i 's/\x0d$//' $Files
    # replace cpp comment line to c comment
    ./ccomment  <$Files 1<>$Files;
    # convert LF -> CRLF
    sed -i 's/$/\x0d/' $Files
done

C'est ok (avec ma petite boucle for !) ?
Des commentaires ou suggestions ?