Projet mkd/Entete de licence

De Wiki EELL.

Version du 30 avril 2013 à 12:35

Retour aux fichiers en développement →

A intégrer dans tous les fichiers source.

• Fichier à revoir ...

/*P
FILE NAME: cpp.c for konsole cpp.cc for individual compilation in c++ or
           cpp.inc.cc to include file in sources files with gtkmm

PROJECT: mkd 
mkd is a UNIX command to extract pre-encoded comments lines to generate the 
software documentation according to ISO standards. 
mkd is the abbreviation of make documentation. This command was originally 
known under the name mkdoc (make documentation).
This command is not integrated into the standard distributions of Unix / Linux

INITIAL PROJECT: 
mkdoc 1989 for MS-DOS and UNIX now obsolete. CEM - University of Montpellier II

ADMINISTRATIVE RECORD: 
extractdoc 04/12/2009



FILE UPDATE:
Date: ../../1986 by JPL Initial programming for MSDOS and UNIX on SUN
Date: ../../1991 by JPL mkdoc 3.12 for PC and UNIX
Date: ../../1995 by JPL mkdoc 3.22 for RED-HAT on LINUX
Date: ../../2004 by JPL mkdoc 4.00 for LINUX ubuntu
Date: 11/02/2010 by JPL Update for MS Visual C10 beta 2. 
Date: ../../.... by JPL Transformation into independant function for mkdcpp.
Date: ../03/2012 by CLARA Update to UTF-8 format (C++)
Date: 02/05/2012 by CLARA Special adaptation for mkdcppw with gtkmm
Date: 10/03/2013 by JPL Rewrite in english (en) to facilitate the translations
Date: 18/03/2013 by GC  Rewrite to correct End Of File control

*/
// Date: ../../.... by ... purpose of the modification ....

/*T
 FILE NAME: cpp.c for konsole cpp.cc for individual compilation in c++ or
           cpp.inc.cc to include file in sources files with gtkmm
 
    Directives de tests unitaires version alpha 2013:
    -------------------------------------------------
    Vérifiez les options n, s et t séparément:
    Vérifiez que la numérotation des lignes est correcte dans tous les cas de
    décodage (lignes et blocs). n, ns. nt, nst.
    Vérifiez que le texte reste à la bonne place dans tous les cas de décodage:
    toute la ligne (dans la cas de la directive de compilation FULL_LINE), ou 
    texte seul.
    -- Vérifiez que les tabulations sont bien prises en charge dans tous les 
       cas, décodage des lignes et des blocs.
    -- Vérifiez de même pour les espaces.
    La fonction doit être éprouvé©e de telle sorte qu'un commentaire qui se 
    termine par le caractère de fin de fichier soit entièrement copié dans le
    fichier cible.
    Le caractère de fin de fichier décodé avant le(les) caractère(s) de fin de
    commentaire doit être remplacé par un caractère de fin de ligne.
 
    Le caractère de fin de fichier (EOF) NE DOIT JAMAIS APPARAÎTRE DANS LE
    TEXTE DU FICHIER CIBLE.
    Ceci provoquait un bug dans la version Alpha de l'application fenêtrée
    mkdcppw à l'étape du test d'intégration.

    Ajouté le 18 avril 2013:
    Vérifiez que l'extraction de tous les commentaires avec pour code de 
    décodage '**' soient copiés et que ceux-ci soient à la bonne place.
 
*/


/*D 
	function cpp_
 -----------------------------------------------------------------------------
 FILE NAME: cpp.c for konsole cpp.cc for individual compilation in c++ or
           cpp.inc.cc to include file in sources files with gtkmm
 FUNTION NAME:
  cpp_
 
 SYNOPSIS, SYNTAX: 
  #include "/usr/include/mkd/version.h" // IMPORTANT: Compilation directives
  #include "/usr/include/mkd/cpp.h"     // or mkd.h
  int cpp_(FILE * pfdoc, FILE * pnfile);
  FILE * pfdoc: pointer of the target file opened by the calling function 
  FILE * pnfile: pointer of the source file opened by the calling function  In UNIX / LINUX 

 ACTION, DESCRIPTION:
  The cpp_ function reads the source file (pnfile) transmitted from the 
  calling function, and decodes the comments pre-encoded in lines or 
  blocks of style c++. and then writing this comments in a target file 
  (pfdoc).
  Pre-coded characters are defined in a external global table 'Codes';

  The golbal variables are 'Codes' and 'Options'.
  The 'Codes': table of 5 characters: 
    extern char codes[]; 
    They must be défined in the calling function:
    char codes[5] = {0,0,0,0,0};
  The 'Options': n,s,t,v:
    extern unsigned char n,s,t;
    They must be dEfined in the calling function:
    unsigned char n=0,s=0,t=0;
  With the options:
    -n: The transcript is preceded by line number. This allows to easily 
       reach the commented line.
    -s: Add the comment to the screen to use shell redirections > , >> , 
       or ||.
    -t: With the t option only the commented text is copied.
       Without the t option the entire line or block is copied.
       The t option permit to generate directly exploitable and publishable
       documents. 

  Remarks:
    If the decoded comment begins with the characters / and *, the  comment
       is copied until find the characters * and /, whatever included any 
       comment-line starting with "//".
    If the decoded comment begins with the characters "//", the line is
       copied until find the end-of-line or new-line 'NL' character or 
       end-of-file 'EOF'.
       This provisions facilitate the automatic generation of header files
       (file.h ; .hpp ; etc.) and documentation of functions.

 CONFORMING TO:
  POSIX, ANSI C, BSD, ISO/IEC 9899:2011; gcc, MS-Vc10; UTF-8.

 PORTABILITY, 
  LINUX-Debian-systems, LINUX-Red-Hat, UNIX, gcc.
  Microsoft Visual studio under Windows : x86(Win32) x64(Win32 and WIN64)

 RETURN VALUE:
  Return 0 in case of success in konsole version, nothing with gtkmm.

 COPYRIGHT:
  © EELL, Éditeurs Européens de Logiciels Libres, EUPL 2007
  Association À  but non lucratif selon l'Article 11 de la convention 
  européenne des droits de l'homme.
  Vous êtes libre de copier reproduire et distribuer l’application selon les
  termes de la Licence EUPL totalement compatible avec la licence GNU.

 
 AUTHORS:
  © Contact: http://edeulo.free.fr/contacts/formmail.php
  Designer: intial JP Louyot (JPL)
  Updates : JPL and Clara Jimenez
  Traducteurs: Clara

 RESSOURCES:
  gtkmm with mkdw future widowed version.

 NOTES:
  Update April 2013 the Coded comment begin also in 3rd colomn

 BUGS:
  See bugs reports http://edeulo.free.fr/phpBB3

 SEE ALSO MANUAL:
  Man(3) attached in English.
  Command line : man 3 cpp_
 
*/

/*H  
	// File: cpp.c (Comments for UTF-8 text editor)
	extern int cpp_ (FILE * pfdoc, FILE * pnfile);
*/


/*
* © mkd, version 2009.12 et ultérieures
*
* Concédée sous licence EUPL, version 1.1 ou – dès leur approbation par la
* Commission européenne - versions ultérieures de l’EUPL (la «Licence»).
* Vous ne pouvez utiliser la présente oeuvre que conformément à la Licence.
* Vous pouvez obtenir une copie de la Licence à l’adresse suivante:
*
* http://ec.europa.eu/idabc/eupl5
*
* Sauf obligation légale ou contractuelle écrite, le logiciel distribué sous
* la Licence est distribué «en l’état»,
* SANS GARANTIES OU CONDITIONS QUELLES QU’ELLES SOIENT, expresses ou implicites.
* Consultez la Licence pour les autorisations et les restrictions linguistiques
* spécifiques relevant de la Licence.
*/

/*P
 -----------------------------------------------------------------------------
 © EELL, contact: http://edeulo.free.fr/wiki/index.php/Utilisateur:eudelo
 © EELL, Editeurs Européens de Logiciels Libres, 20074
 Association à but non lucratif selon l'Article 11 de la convention 
 européenne des droits de l'homme.
*/

/*O
	NOM DU FICHIER : 
	PROJET : mkd http://edeulo.free.fr/wiki/index.php/Portail:mkd
	PROJET INITIAL: mkdoc 1989 pour MS-DOS et UNIX, devenu obsolète.
	DOSSIER : http://edeulo.free.fr/wiki/index.php/Projet_mkd
	PROGRAMMEUR: http://edeulo.free.fr/wiki/index.php/Utilisateut:<User> 
	DATE: 
	MODIFICATIONS:
	Le: ../../.. par .............. objet de la modification ....
	Le: ../../.. par
*/