home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / prog / c / stripit.lha / StripIt / StripIt.dok < prev    next >
Text File  |  1992-10-13  |  11KB  |  322 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                  DOKUMENTATION ZU
  12.  
  13.  
  14.                       StripIt  VERSION  1.3 FREEWARE VERSION
  15.  
  16.  
  17.                              geschrieben 1992 von H.P.G.
  18.  
  19.  
  20.  
  21. INDEX:
  22.  
  23.             INDEX
  24.             Allgemeine Beschreibung
  25.             Features
  26.             Benutzen von StripIt
  27.             System Vorraussetzungen
  28.             Rechtliches
  29.             Installation
  30.             Cli-Syntax
  31.             Konfigurationsdatei
  32.             Technisches
  33.             Zum Schluß
  34.             Adresse
  35.             Liste der Dateien
  36.  
  37. Allgemeine Beschreibung
  38.  
  39.     StripIt ist ein Programmier-Tool.
  40.     StripIt entfernt alle Arten von  Kommentaren  aus  den  Quell-Codes.
  41.     Es ist für alle Arten von Programmiersprachen geeignet.
  42.     StripIt benötigt OS 2.xx zum laufen.  Es  ist  unter  Kickstart  1.2
  43.     und 1.3 leider nicht lauffähig.
  44.  
  45.  
  46. Features
  47.  
  48.     Allgemein konfigurierbar für alle Sprachen durch Konfigurationsdatei.
  49.  
  50.     StripIt ist schnell und einfach zu  handhaben.  (Kein  Vergleich  zu
  51.     z.B.: stripc von Manx etc.).
  52.  
  53.     StripIt kann jederzeit mittels ^C abgebrochen  werden,  ohne  Daten-
  54.     verluste.
  55.  
  56.     Angabe von mehreren Quell-Codes möglich. In diesem Fall  werden  sie
  57.     von den Kommentaren befreit und an die ZielDatei angehängt.
  58.  
  59.     StripIt ist ein OS 2.xx Tool, d.h. es ist kürzer als Tools  die  mit
  60.     OS 1.3 und 2.xx laufen.
  61.  
  62.  
  63. Benutzen von StripIt
  64.  
  65.     StripIt ist z.Bsp. dann von Nutzen, wenn man alle Kommentare von den
  66.     Include-Dateien  löschen  will.  Dies  führt  zu  einer  erheblichen
  67.     Geschwindigkeitssteigerung beim kompilieren.
  68.  
  69.     Oder man hat alte  Quell-Dateien,  die  man  mit  neuen  Kommentaren
  70.     versehen  will.  Manuell  jeden  Kommentar  zu  löschen,  würde  bei
  71.     größeren Quell-Dateien  zu  einem  Lebenswerk  werden.  Mit  StripIt
  72.     dauert das nur wenige Sekunden.
  73.  
  74.  
  75. System Vorraussetzungen
  76.  
  77.     Man braucht mindestens OS 2.xx Version 37. Mit  Version  36  könnten
  78.     Probleme auftauchen, da hier einige  Funktionen  noch  nicht  einge-
  79.     baut waren, die von StripIt benutzt werden.
  80.  
  81.  
  82. Rechtliches:
  83.  
  84.  
  85.         Ich habe mich entschlossen dieses Programm und alle beigefügten
  86.         Dateien und Scripts, sowie aller Anleitungen, als FREEWARE   zu
  87.         deklarieren.
  88.  
  89.         D.h.:
  90.  
  91.             Jeder kann StripIt benutzen.
  92.             Jeder darf StripIt weitergeben, wenn:
  93.  
  94.                 1. Alle unten aufgeführten Programme mit  weitergegeben
  95.                    werden,
  96.  
  97.                 2. Keinerlei Veränderungen der unten aufgeführten  Pro-
  98.                    grammen (am Ende der Anleitung)  vorgenommen wurden,
  99.  
  100.                 3. Bei  Nachkompilierungen  der QuellCodes muß ein Hin-
  101.                    weis  auf  den  Orginalprogrammierer beigefügt sein,
  102.                    bei  Herausgabe  dieser,  muß  eine  Kopie  an  mich
  103.                    gesandt werden.
  104.  
  105.                 4. StripIt darf nicht verkauft werden.
  106.  
  107.                        Außnahme: Es darf eine geringe  Kopiergebühr er-
  108.                                  hoben werden, die aber  5 DM  bzw. den
  109.                                  entsprechenden  Gegenwert  in  anderen
  110.                                  Währungen nicht übersteigt.
  111.  
  112.                 5. StripIt darf nur als Teil eines kommerziellen Produktes
  113.                    herrausgegeben  werden,  mit ausdrücklicher schrift-
  114.                    licher Genehmigung des Autors (Adresse siehe unten).
  115.  
  116.                 Zuwiderhandlungen  der  oben  Aufgeführten  Konditionen
  117.                 werden Zivilrechtlich verfolgt.
  118.  
  119.  
  120.         Ferner  wird  für  die Funktion des Programmes ,sowie möglicher
  121.         Folgen  der  Benutzung  des Programmes sowie der u. a. Dateien,
  122.         keinerlei Gewährleistung übernommen.
  123.  
  124.         !!! Alle Risiken trägt der Benutzer allein !!!
  125.  
  126.  
  127. Installation
  128.  
  129.     Am Besten ist es, das  Programm  in  das  Verzeichnis  zu  kopieren,
  130.     indem man auch seinen Kompiler,  Assembler  oder  Linker  etc.  hat.
  131.     Auf jeden Fall sollte das Verzeichnis im  AmigaDOS-Suchpfad  liegen.
  132.  
  133.  
  134. Cli-Syntax
  135.  
  136.     StripIt ist nur vom CLI aus startbar und hat folgende Syntax:
  137.  
  138. SYNTAX: Stripit [SRC/M/A][TO/A][Cfg/K][C/S]
  139.  
  140. wobei
  141.  
  142.         SRC/M/A         SRC ist der Name der  Quell-Datei(en),  von  der
  143.                         man die Kommentare löschen  will.  SRC  muß  an-
  144.                         gegeben  werden.  Es   können   mehrere   Quell-
  145.                         Dateien angegeben  werden.  Dabei  muß  man  be-
  146.                         achten, daß man nicht vergißt  auch  eine  Ziel-
  147.                         datei anzugeben. Werden nämlich  mehrere  Quell-
  148.                         Dateien  angegeben  und  keine  Zieldatei,  dann
  149.                         nimmt StripIt an,  daß  die  letzte  Quell-Datei
  150.                         die  Zieldatei  ist  und   überschreibt   diese.
  151.                         !!! VORSICHT !!!.
  152.  
  153.  
  154.         TO/A            TO ist der Name der Zieldatei. TO muß  angegeben
  155.                         werden. Werden mehrere Quell-Dateien  angegeben,
  156.                         werden alle diese Datei zunächst von ihren  Kom-
  157.                         mentaren befreit und dann an  TO  angehängt.  Es
  158.                         verhält sich also ähnlich wie das JOIN-Kommando.
  159.                         Man kann für TO nicht die gleiche Datei, wie für
  160.                         SRC angeben. Dies kann zu Datenverlusten führen.
  161.  
  162.         CFG/K           Wird CFG gefolgt von den Namen einer  Konfigura-
  163.                         tionsdatei  angegeben,  benutzt  StripIt   diese
  164.                         Datei. Über die Syntax dieser Datei spreche  ich
  165.                         weiter unten. Diese Datei enthält  alle  Kommen-
  166.                         tarzeichen, die aus den  SRC-Datei(en)  gelöscht
  167.                         werden sollen.
  168.  
  169.         C/S             C ist ein Schalter. Wird  C  angegeben,  benutzt
  170.                         StripIt  die  eingebaute  Kommentarzeichen   der
  171.                         C-Sprache.  Bekannte  C-Kommentarzeichen   sind:
  172.                         /* , */ , // . Die  `//`  sind  ein  Support  an
  173.                         ANSI-kompatible  Kompiler  und  geben  an,   daß
  174.                         alles was nach  einem  //  in  der  Zeile  steht
  175.                         ein Kommentar ist.
  176.  
  177.  
  178. Konfigurationsdatei
  179.  
  180.     StripIt kennt zwei verschiedene Arten von Kommentaren.
  181.  
  182. 1.  Die erste ist ein Kommentar, der mit einer  bestimmten  Zeichenkette
  183.     anfängt und mit einer anderen Zeichenkette  endet.  Zwischen  diesen
  184.     beiden Zeichenketten befindet sich der Kommentar.
  185.  
  186.     z.Bsp.:
  187.  
  188.                   /* : Ist der Anfang einer C-Kommentarzeile
  189.                   */ : Ist das Ende einer C-Kommentarzeile
  190.  
  191.                   /* Oder auch das */ Das hier nicht mehr
  192.  
  193.     ähnliches gibt es auch in anderen Programmiersprachen.
  194.  
  195. ACHTUNG: StripIt unterstützt keine verschachtelten Kommentare.
  196.          z.Bsp.:
  197.                  '/* Hallo /* Kommentar 2 */ */'
  198.  
  199.          würde zu einem Fehler führen,  da  StripIt  nur  auf  das  Ende
  200.          eines Kommentares wartet. TO würde also
  201.  
  202.                  '                            */'
  203.  
  204.          enthalten.
  205.  
  206. 2.  Die zweite Kommentarart beginnt mit einer Zeichenkette und endet am
  207.     Zeilenende.
  208.  
  209.     z.Bsp.:
  210.  
  211.                    ;   : Alles hinter dem Zeichen ist ein Kommentar
  212.                    *   : Dies könnte ein Kommentar von Assembler sein
  213.                    ;   : auch in AmigaDOS-Batchdateien gibt es Kommentare
  214.                    REM : Sogar in BASIC gibt es Kommentare
  215.  
  216. Um  nicht  für  jede  Programmiersprache  einen   Kommandozeilenschalter
  217. einbauen zu müssen, ist StripIt von  einer  Konfigurationsdatei  steuer-
  218. bar. Somit ist es auch möglich  bei  neuen  Programmiersprachen  StripIt
  219. weiter zunutzen.
  220.  
  221. Um die oben gezeigten zwei Arten von Kommentaren unterscheiden zu können,
  222. hat die Konfigurationsdatei folgende Syntax:
  223.  
  224. .sta ##
  225. .end ##
  226. .lin ##
  227.  
  228. Anstelle von ## stehen die jeweiligen Kommentarzeichen.
  229.  
  230. .sta bedeutet: Die Zeichen, die hinter .sta stehen, repräsentieren eine
  231.                Zeichenkette, die einen Kommentar einleiten.
  232.  
  233. .end bedeutet: Die Zeichen, die hinter .end stehen, repräsentieren eine
  234.                Zeichenkette, die einen Kommentar beenden.
  235.  
  236. D.h: .sta ## muß immer von dem dazugehörigen .end ## gefolgt werden,
  237.       sonst kann es zu Datenverlusten kommen.
  238.  
  239. .lin bedeutet: Die Zeichen, die hinter .lin stehen, repräsentieren eine
  240.                Zeichenkette, die einen Kommentar einleiten, der bis zum
  241.                Zeilenende geht.
  242.  
  243.                D.h: Alles, was hinter ## in der Quell-Datei steht, wird
  244.                bis zum Zeilenende gelöscht.
  245.  
  246. Es können bis zu  10 (!) verschiedene Kommandoanweisungen angegeben wer-
  247. den. Dies sollte für alle Programmiersprachen ausreichen.
  248.  
  249. Ich habe einige (zugegeben simple) Beispielkonfigurationsdateien in dem
  250. Beispiel- (Examples) Verzeichnis, zu Batch-,Csh-,Dme-,ASM- etc Kommen-
  251. taren beigelegt.
  252.  
  253.  
  254.  
  255. Technisches
  256.  
  257.                StripIt benutzt viele OS 2.xx Features, für  Commandline-
  258.                Parsing               Standartausgaben               usw.
  259.                Trotzdem ist StripIt ziehmlich groß geworden. Das  resul-
  260.                tiert  zum  einen  aus  der  komplexen   Aufgabenstellung
  261.                ( Konfigurierbarkeit, eingebaute C kommentare  usw.)  zum
  262.                Anderen  aus  Sicherheitsgründen  (Break  Handling  usw).
  263.                StripIt kann zu jeder Zeit  mit  ^C  abgebrochen  werden.
  264.                Bevor StripIt  beendet,  werden  zuerst  alle  geöffneten
  265.                Dateien wieder geschlossen.
  266.                Je mehr Kommentarzeichen angegeben werden,  desto  länger
  267.                der strip-Vorgang dauern. Bei voll genutzten  10  Kommen-
  268.                taren, und größeren Quell-Dateien kann  dies  schon  eine
  269.                geraume Zeit dauern. In einem  solchen  Fall  sollte  man
  270.                StripIt  als  BackgroundProcess  starten  und  die  Task-
  271.                Priorität  heruntersetzen,  damit  StripIt  das  arbeiten
  272.                mit anderen Programmen nicht stört.  StripIt  läuft  nor-
  273.                malerweise mit Priorität 0.
  274.  
  275.  
  276. Zum Schluß
  277.  
  278.                Ich  hoffe  StripIt  wird  von  vielen  Leuten   benutzt.
  279.                Wenn sich Fehler des  Programmes  herausstellen  sollten,
  280.                so laßt es mich wissen. Auch konstruktive Kritik und/oder
  281.                Ideen sind willkommen.
  282.                Schreibt an die unten angegebene Adresse.
  283.  
  284.  
  285. Adresse
  286.  
  287.  
  288.                 Hans-Peter Günther
  289.                 Grüner Weg 5
  290.                 D-3501 Fuldatal 2
  291.                 B.R.D. (Germany)
  292.  
  293. Liste der Dateien:
  294.  
  295. List of files
  296.  
  297. (Fehlt eine der folgenden Dateien, ist diese Veröffentlichung inkomplett)
  298.  
  299. StripIt           : Das Programm
  300. StripIt.info
  301. StripIt.doc       : Englische Anleitung
  302. StripIt.doc.info
  303. StripIt.dok       : Deutsche Anleitung
  304. StripIt.dok.info
  305. CfgFiles          : Verzeichnis mit einigen Beispielkonfigurationen
  306.     csh.cfg       : für csh
  307.     dme.cfg       : für dme
  308.     asm.cfg       : für assembler
  309.     dos.cfg       : für batch files
  310. CfgFiles.info
  311. ExampleSrc        : Verzeichnis mit einigen Beispiel Quellcodes
  312.     ex.c          : in C
  313.     ex.s          : in assembler
  314.     ex.sh         : in csh script Sprache
  315.     ex.dme        : in dme script Sprache
  316.     ex.bat        : in dos script Sprache
  317. ExampleSrc.info
  318.  
  319.  
  320. --------ENDE
  321.  
  322.