home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / pascal / utility / beauty / tvpretty / pasform.txt < prev    next >
Text File  |  1993-07-27  |  12KB  |  289 lines
  1.  
  2.  
  3.  
  4.        Kurzbeschreibung TVPascalForm
  5.        Version 1.00 - Mär. 1993
  6.  
  7.        alle Rechte bei: Jeanette Winzenburg
  8.        Arndtstr. 12, W-1000 Berlin 61 (ab 7/93: 10965 Berlin)
  9.  
  10.        Testen Sie das Programm nach Herzenslust, aber denken
  11.        Sie daran, daß es sich um eine Shareware-Version
  12.        handelt: wenn Sie es regelmäßig benutzen, spätestens
  13.        aber nach Ablauf der Testzeit von 3 Monaten, müssen Sie
  14.        eine registrierte Version (zum fairen Preis von 30,00
  15.        DM bei Vorkasse; bei Nachnahme + 6,- DM) erwerben. Die
  16.        Datei REGFORM.TXT enthält ein Registrierungsformular,
  17.        bereit zum Ausdrucken und Abschicken.
  18.  
  19.        Eine Registrierung bringt einige Vorteile:
  20.        - Sie erhalten 50% Rabatt auf das nächste Update.
  21.        - Sie erhalten den vollständigen Quelltext.
  22.        - Sie können in den Genuß von immer besseren
  23.        Programmiertools kommen, weil Sie die weitere
  24.        Programmentwicklung fördern.
  25.  
  26.  
  27.  
  28.        Inhalt                                   
  29.  
  30.        Programmidee                             
  31.        Optik                                    
  32.        Funktionsübersicht                       
  33.        Die Funktionen im Einzelnen              
  34.        Fehlerbehandlung                         
  35.        Grenzen - was TVPascalForm nicht kann/können will 
  36.        Ein Kessel Buntes - Hinweise
  37.  
  38.  
  39.        Programmidee
  40.  
  41.        TVPascalForm ist eine Turbo Vision Applikation, mit der
  42.        komfortabel alle Bezeichner in Pascal-Quelltexten in
  43.        eine einheitliche Schreibweise gebracht werden.
  44.  
  45.        Die Leitidee bei der Programmentwicklung war, die
  46.        Konvertierung so automatisch wie möglich - und das für
  47.        ALLE Bezeichner - ablaufen zu lassen. Die
  48.        ProgrammiererIn soll möglichst vollständig von der
  49.        lästigen Aufgabe des Wortlisten-Tippens verschont
  50.        bleiben. Als Folge davon fordert TVPascalForm für jeden
  51.        gefundenen unbekannten Bezeichner eine verbindliche
  52.        Schreibweise an - und merkt sich die Antwort für
  53.        künftige Anwendungen in einer selbstadaptierenden
  54.        Liste.
  55.  
  56.  
  57.        Optik
  58.  
  59.        Nach dem Start zeigt sich TVPascalForm im gewohnten
  60.        TurboVision-Look mit Menüzeile, Desktop und Statuszeile
  61.        - das Hinweisfenster erinnert Sie daran, daß Sie eine
  62.        Shareware-Version testen. Der Datei-Dialog zur Auswahl
  63.        eines Quelltextes ist aktiviert.
  64.  
  65.        In der Statuszeile werden die wichtigsten Befehle
  66.        angezeigt, zusätzlich ist rechts unten der freie Heap
  67.        eingeblendet, bei < 80k in roter Schrift.
  68.  
  69.  
  70.        Funktionsübersicht
  71.  
  72.        Mit den unter TurboVision üblichen Mittel -
  73.        Menüauswahl, Hotkey, Mausclick - wird ein Quelltext
  74.        ausgewählt und gleichzeitig die Konvertierung aller
  75.        darin enthaltenen Bezeichner in eine einheitliche
  76.        Schreibweise gestartet. Diese Bearbeitungsfunktion ist
  77.        nach dem Programmstart und nach jeder erfolgreich
  78.        abgeschlossenen Textkonvertierung aktiviert.
  79.  
  80.        Findet die Applikation einen ihr bisher unbekannten
  81.        Bezeichner, fordert sie in einem Dialogfenster die
  82.        Festlegung seiner Schreibweise an. Die gültige
  83.        Schreibweise wird in eine interne Liste eingefügt; die
  84.        Liste wird bei Programmende gespeichert.
  85.  
  86.        Nach Ende der Schönheitsoperation wird die geliftete
  87.        Datei gespeichert, der Ausgangstext steht als Backup
  88.        auch weiter zur Verfügung.
  89.  
  90.        Daneben können die Referenzlisten editiert,
  91.        ausgewechselt und auch - obwohl das der Programmidee
  92.        zuwiderläuft! - aus ASCII-Listen importiert / zu ASCII-
  93.        Listen exportiert werden.
  94.  
  95.  
  96.        Die Funktionen im Einzelnen
  97.  
  98.        Als TurboVision Applikation hält sich die
  99.        Programmbedienung an die von Pascal 6.0 gewohnten IDE-
  100.        Konventionen, die hier nicht wiederholt werden.
  101.  
  102.        Die Menüzeile hat folgende Auswahlmenüs:
  103.        Bearbeiten     Textkonvertierung, Dateioperationen
  104.        Wortlisten     Funktionen an den Referenzlisten
  105.  
  106.  
  107.        Der Menüpunkt Bearbeiten
  108.  
  109.        Er enthält die Funktionen zur Auswahl und Bearbeitung
  110.        des Quelltextes, zum Verzeichniswechsel, zur
  111.        Programmunterbrechung und zum Programmende.
  112.  
  113.        Bearbeiten
  114.             öffnet einen Datei-Dialog mit dem ein Pascal-
  115.             Quelltext zur Bearbeitung ausgewählt werden kann.
  116.             Bei fehlerfreiem Öffnen wird die Textkonvertierung
  117.             gestartet - ein Hinweis "Bitte warten ..."
  118.             erinnert Sie daran. Jedes Wort des Quelltextes
  119.             wird mit den Referenzlisten abgeglichen; ist es
  120.             nicht enthalten, erscheint auf dem Desktop ein
  121.             Dialogfenster, in dem die Schreibweise festgelegt
  122.             werden kann. Gleichzeitig wird die gesamte gerade
  123.             bearbeitete Zeile zur besseren Orientierung
  124.             eingeblendet. Bei Abbruch des Dialogs wird nach
  125.             Bestätigung die gesamte Bearbeitung abgebrochen,
  126.             die Ausgangsdatei ist unverändert.
  127.             Nach erfolgreicher Bearbeitung wird die geschönte
  128.             Datei gespeichert, die Ausgangsdatei steht als
  129.             Backup mit der Dateikennung ".JBK" zur Verfügung.
  130.             Dieser Menüpunkt ist automatisch nach dem
  131.             Programmstart und nach jeder Bearbeitung
  132.             aktiviert.
  133.  
  134.        Verzeichnis wechseln
  135.             öffnet einen ChangeDirDialog.
  136.  
  137.        DOS-Shell
  138.             wechselt zur DOS-Ebene, wenn der Arbeitsspeicher
  139.             ausreicht; Rückkehr wie üblich mit "Exit".
  140.  
  141.        Exit
  142.             Programmende; wurde die interne Wortliste
  143.             geändert, wird Speicherung vorgeschlagen.
  144.  
  145.  
  146.        Der Menüpunkt Wortlisten
  147.  
  148.        Er enthält die Funktionen zum Editieren und Auswechseln
  149.        der Referenzlisten. Daneben gibt es eine Funktion zum
  150.        Import/Export von reinen ASCII-Listen.
  151.  
  152.        Intern verwaltet TVPascalForm drei Wortlisten, die in
  153.        dieser Reihenfolge abgearbeitet werden:
  154.  
  155.        - Reservierte Liste: Sie enthält die reservierten
  156.        Bezeichner von TP 6.0.
  157.        - Standard-Liste: Sie enthält die Standard-Bezeichner
  158.        von TP 6.0.
  159.        - Individual-Liste: Sie enthält die selbstadaptierende
  160.        Liste, in die neue Bezeichner eingefügt werden.
  161.  
  162.        Beim Programmstart liest TVPascalForm die drei Listen
  163.        aus dem Dateien ResWort.JLT, Standard.JLT und
  164.        MeinWort.JLT aus dem Verzeichnis, in dem das Programm
  165.        gespeichert ist: die Listen sind als NachfolgeObjekte
  166.        von TStringCollection gespeichert.
  167.  
  168.        Reservierte, Standard. Individual editieren
  169.             öffnet ein Dialogfenster, in dem Listeneinträge
  170.             geändert bzw. neue Bezeichner eingefügt werden
  171.             können. Es enthält eine Listbox mit der Wortliste,
  172.             eine Eingabezeile und die Aktionsschalter Ersetze
  173.             (Default), Neu, Speichern und Abbruch.
  174.  
  175.             Listbox: durch Selektion eines Bezeichners wird
  176.             dieser in die Eingabezeile übertragen und steht
  177.             dort zur Änderung bereit.
  178.  
  179.             Ersetze: der Text in der Eingabezeile ersetzt den
  180.             fokussierten Listeneintrag; insbesondere wird der
  181.             Eintrag gelöscht, wenn die Eingabezeile leer ist.
  182.             (s. auch: Hinweise)
  183.  
  184.             Neu: der Text der Eingabezeile wird in die Liste
  185.             eingefügt.
  186.  
  187.             Speichern: der Dialog wird beendet, die geänderte
  188.             Liste wird mit einem Backup der Dateikennung
  189.             ".JBK" gespeichert.
  190.  
  191.             Abbruch: der Dialog wird beendet, die Wortliste
  192.             ist unverändert.
  193.  
  194.        Listeninfo
  195.             die Dateinamen der aktuellen Referenzlisten werden
  196.             in einem Fenster angezeigt.
  197.  
  198.        Reservierte, Standard, Individual auswechseln
  199.             öffnet einen Datei-Dialog, mit dem eine Datei zum
  200.             Lesen einer neuen Liste ausgewählt werden kann.
  201.             Bei Erfolg ersetzt die neue Liste die bisher
  202.             gültige. Die aktuelle Individual-Liste wird mit
  203.             Backup gespeichert.
  204.  
  205.        als ASCII
  206.             öffnet einen Datei-Dialog, mit dem eine Datei zum
  207.             Lesen einer Referenzliste ausgewählt werden kann.
  208.             Bei Erfolg wird eine daraus erstellte ASCII-Liste
  209.             (mit einem Wort pro Zeile) in einer Datei mit
  210.             Kennung ".JXT" gespeichert. Existiert bereits eine
  211.             Datei dieses Namens, so wird sie überschrieben.
  212.  
  213.        als Resource
  214.             öffnet einen Datei-Dialog, mit dem eine Datei zum
  215.             Lesen einer ASCII-Liste (in der jeweils ein
  216.             Bezeichner pro Zeile erwartet wird) ausgewählt
  217.             werden kann. Bei Erfolg wird eine daraus erstellte
  218.             Referenzliste in einer Datei mit der Dateikennung
  219.             ".JLT" gespeichert. Existiert bereits eine Datei
  220.             dieses Namens, so wird sie überschrieben.
  221.  
  222.  
  223.        Fehlerbehandlung
  224.  
  225.        Tritt bei der Ausführung einer Funktion ein Fehler auf,
  226.        stellt TVPascalForm so weit wie möglich den Zustand vor
  227.        dem Aufruf der Funktion wieder her und zeigt eine
  228.        Fehlermeldung.
  229.  
  230.  
  231.        Grenzen
  232.  
  233.        -    TVPascalForm ist für fehlerfrei kompilierbare
  234.             Pascal-Quelltexte konzipiert. Bei beliebigen
  235.             Texten kann eine Bearbeitung auch funktionieren -
  236.             Stringkonstanten oder Wortanfänge, die keine
  237.             gültigen Pascal-Wortanfänge (z. B. Ziffern,
  238.             Umlaute ...) sind, können dann aber zu Problemen
  239.             führen.
  240.  
  241.        -    Eine Sonderbehandlung für Kommentare ist nicht
  242.             vorgesehen.
  243.  
  244.  
  245.        Hinweise - ein Kessel Buntes
  246.  
  247.        -    Stringkonstanten werden unverändert übernommen.
  248.  
  249.        -    Einzelbuchstaben und Hexadezimalzahlen werden
  250.             grundsätzlich in Großbuchstaben konvertiert.
  251.  
  252.        -    Im Dialogfenster zum Bearbeiten von Wortlisten
  253.             wird der fokussierte Eintrag der Listbox nur
  254.             ersetzt, wenn die Eingabezeile selektiert ist: die
  255.             Idee dabei ist, das Wort nicht unbeabsichtigt zu
  256.             verändern. Als unschöne Folge kann der Schalter
  257.             "Ersetze" nicht mit der Maus, sondern nur über die
  258.             Tastatur bedient werden. Sorry: das ist ein klarer
  259.             Verstoß gegen TV-Prinzipien, hat sich in der
  260.             Praxis aber als sinnvoll herausgestellt. Für
  261.             Vorschläge zu einer prinzipientreuen Lösung bin
  262.             ich jederzeit offen...
  263.  
  264.        -    In der - auch in TVPascalForm eingesetzten - TV
  265.             Unit Stddlg ist im TFiledialog ein Bug, der das
  266.             Programm sang- und klanglos abstürzen läßt, wenn
  267.             auf einem Diskettenlaufwerk beim Öffnen des
  268.             Filedialogs keine Datei mit dem übergebenen
  269.             Dateinamen zu finden ist. Als "quick and dirty"-
  270.             Lösung legt TVPascalForm deshalb eine Datei
  271.             "DUMMY" + aktuelle Dateikennung an, wenn er im
  272.             aktuellen Verzeichnis keine passende Datei findet.
  273.             Sorry!
  274.  
  275.        -    TV übernimmt die Fehlerbehandlung bei Disk-Errors:
  276.             in der Statuszeile erscheint dann eine - englische
  277.             - Fehlermeldung. Wie schon in der TV-Dokumentation
  278.             erwähnt, muß man dann in der Regel mehrfach Esc
  279.             bzw Enter drücken. Eventuell ist auch die dann
  280.             folgende Messagebox unpassend. Nun aber nicht die
  281.             Nerven verlieren, sondern Fehler beheben und
  282.             nochmal probieren!
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.