{FlexCat

{Der flexible Kataloggenerator

{

{Version 1.0

Jochen Wiedmann

Diese Dokumentation sowie das gesamte Programmpaket d�rfen im Rahmen der “GNU General Public License” kopiert, ver�ndert und weitergegeben werden solange diese Copyright-Notiz und diese Erlaubnis unver�ndert auf allen Kopien enthalten ist und die “GNU General Public License” der Free Software Foundation (in der Datei COPYING) mitkopiert und weitergegeben wird.

Es wird keine Garantie gegeben, da� die Programme, die in dieser Dokumentation beschrieben werden, 100%ig zuverl�ssig sind. Sie benutzen diese Programme auf eigene Gefahr. Der Autor kann auf keinen Fall f�r irgendwelche Sch�den verantwortlich gemacht werden, die durch die Anwendung dieser Programme entstehen.


\input texinfo

[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1 �bersicht

Seit der Workbench 2.1 bietet der Amiga ein sehr sch�nes System an, mit dem Programme in verschiedenen, praktisch beliebigen Sprachen benutzt werden k�nnen: Die locale.library. (Man nennt diesen Vorgang Lokalisierung, daher der Name.)

Die Idee ist eigentlich recht simpel: Man w�hlt eine Sprache, meist die englische aus und schreibt sein Programm ganz normal, abgesehen davon, da� Strings nicht mehr direkt eingegeben werden, sondern �ber einen Funktionsaufruf im Programm verwendet werden. Durch einen weiteren Funktionsaufruf zu Beginn des Programms erh�lt der Benutzer nun die M�glichkeit, anstelle der vorgegebenen Strings andere zu w�hlen, die in einer externen Datei, einem sogenannten Katalog enthalten sind.

Diese Katalogdateien sind vom Programm unabh�ngig. M�chte man das Programm in einer weiteren Sprache betreiben, so ist lediglich eine neue Katalogdatei zu erzeugen, das eigentliche Programm mu� nicht ge�ndert werden.

Auf den Programmierer kommen dadurch aber zus�tzliche Aufgaben hinzu: Es m�ssen die Kataloge erzeugt werden, die Strings nach wie vor eingegeben werden und es mu� zus�tzlicher Code erzeugt werden, der die Behandlung der Kataloge �bernimmt. Dies soll durch FlexCat so weit wie m�glich vereinfacht und automatisiert werden, ohne dabei auf Flexibilit�t (vor allem in Bezug auf den erzeugten Quelltext) zu verzichten. Mit FlexCat geht das Ganze folgenderma�en vor sich:

  1. Es wird zun�chst eine Datei erzeugt, in der die vorgegebenen Strings enthalten und beschrieben sind: Die Katalogbeschreibungsdatei. Die Beschreibung enth�lt neben den Strings z.B. Angaben �ber minimale und maximale L�nge. See section Aufbau einer Katalogbeschreibungsdatei.
  2. Mit Hilfe einer Quelltextbeschreibungsdatei wird aus der Katalogbeschreibung Quelltext erzeugt: Die Quelltextbeschreibung ist praktisch eine Vorlage, in der FlexCat gewisse Symbole durch vorgegebene Werte, z.B. die Strings aus der Katalogbeschreibung ersetzt. Da die Quelltextbeschreibungsdatei mit einem Editor bearbeitet werden kann, kann der Quelltext an beliebige Programmiersprachen und f�r beliebige Anforderungen angepa�t werden. Gewisse Vorlagen (in Assembler, Oberon und C, letzteres wahlweise mit Lokalisierung unter 2.0 oder erst ab 2.1) sind bereits vorhanden. Sie k�nnen entweder als Beispiele dienen oder einfach verwendet werden, ohne sich �ber den erzeugten Quelltext den Kopf zu zerbrechen. See section Aufbau einer Quelltextbeschreibungsdatei.
  3. Mit Hilfe von FlexCat kann man dann f�r jede zus�tzliche Sprache eine Katalog�ber\-setzungs\-datei erzeugen. Diese �hnelt der Katalogbeschreibungsdatei, enth�lt aber f�r jeden String eine leere Zeile. In diese m�ssen nun die entsprechenden Strings in der neuen Sprache eingetragen werden. Damit dies m�glichst einfach geht, folgen auf die leeren Zeilen jeweils Kommentarzeilen, die die urspr�nglichen Strings enthalten. Es ist dadurch immer klar, welcher String wo einzusetzen ist. Aus der Katalogbeschreibungs- und der -�bersetzungsdatei kann FlexCat dann anschlie�end einen Katalog erzeugen. (Dieser Vorgang kann zu beliebiger Zeit erfolgen, auch wenn das Programm l�ngst fertig ist.) See section Aufbau einer Katalog�bersetzungsdatei.

[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2 Installation des Programms

FlexCat ist in Ansi-C geschrieben und sollte daher auf jedem Amiga und nach evtl. Neucompilierung sogar auf jedem anderen Rechner laufen. Das gilt ebenso f�r die erzeugten Programme, denn FlexCat ist mit sich selbst erzeugt worden. Die mitgelieferten Quelltextbeschreibungen sollten Programme erzeugen, die auf jedem Amiga und sogar auf beliebigen Rechnern lauff�hig sind. (Allerdings sollte man dann beim Aufruf der FlexCat-Funktionen sicherstellen, da� die Variable LocaleBase den Wert NULL hat. Lokalisierung ist aber meist nur auf dem Amiga und ab der Workbench 2.1 m�glich, da erst dann die locale.library zur Verf�gung steht.

Es ist aber prinzipiell durchaus m�glich, auch unter einer fr�heren Workbench oder gar auf anderen Rechnern Lokalisierung anzubieten: Ein Beispiel daf�r liefern die Quelltextbeschreibungsdateien ‘C_c_V20.sd’ und ‘C_h_V20.sd’, in denen die locale.library durch die iffparse.library ersetzt wird, falls letztere vorhanden ist, erstere dagegen nicht. Damit ist Lokalisierung schon ab der Workbench 2.0 m�glich. See section FlexCat-Quelltext in C-Programmen.

Zur Installation ist nichts weiter zu tun, als das eigentliche Programm an eine sinnvolle Stelle Ihres Suchpfades zu kopieren und einen geeigneten Platz f�r die Quelltextbeschreibungen auszuw�hlen. Falls Sie mit einer anderen als der englischen Sprache arbeiten wollen, m�ssen Sie au�erdem den entsprechenden Katalog an eine geeignete Stelle kopieren. Im Falle der deutschen Sprache (die derzeit die einzige verf�gbare ist) w�re die Datei ‘Catalogs/Deutsch/FlexCat.catalog’. Der einfachste Platz ist das Verzeichnis ‘Locale:Catalogs/Deutsch’, m�glich ist aber auch, einfach das ganze Verzeichnis ‘Catalogs’ in das Directory des Programms zu kopieren. See section Einbau des erzeugten Quelltextes in eigene Pro\-gram\-me.


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3 Aufruf des Programms

FlexCat arbeitet nur vom CLI aus. Die Aufrufsyntax ist

    FlexCat CDFILE/a,CTFILE,CATALOG/k,NEWCTFILE/k,SOURCES/m

Dies ist die Bedeutung der Argumente:

CDFILE

ist der Name einer zu lesenden Katalogbeschreibungsdatei. Diesen anzugeben ist obligatorisch. Aus diesem Argument wird auch der Basisname bei der Quelltextbeschreibung gewonnen. Achten Sie deshalb auf Gro�-/Kleinschreibung! See section Aufbau einer Quelltextbeschreibungsdatei.

CTFILE

ist der Name einer zu lesenden f�r die Erzeugung von Katalogen zu lesenden Katalog�bersetzungsdatei. Au�erdem kann man eine vorhandene Katalog�bersetzungsdatei mit Hilfe des Argumentes NEWCTFILE auf den neuesten Stand zu bringen: Wird beides angegeben, so wird zun�chst die Katalogbeschreib\-ungs- und dann die -�bersetzungsdatei gelesen und anschlie�end eine neue Katalog�bersetzungsdatei erzeugt, die dieselben Strings wie die alte und evtl. neue Strings (als Leerzeile) enth�lt.

CATALOG

ist der Name eines zu erzeugenden Kataloges. Dieses Argument ist nur gemeinsam mit der Verwendung CTFILE erlaubt.

NEWCTFILE

ist der Name einer neu zu erzeugenden Katalog�bersetzungsdatei. Wie schon gesagt, werden die Strings aus einer evtl. durch CTFILE angegebenen bestehenden Datei �bernommen. Fehlt das Argument CTFILE, so wird eine Datei erzeugt, die nur Leerzeilen als Strings enth�lt.

SOURCES

sind die Namen zu erzeugender Quelltextdateien sowie der dazu zu lesenden Quelltextbeschreibungsdateien. Diese Argumente m�ssen die Form ‘source=template’ haben, wobei ‘source’ der Name der zu erzeugenden Quelltextdatei und ‘template’ der Name der Quelltextbeschreibungsdatei ist.

Ein Beispiel:

FlexCat Prog.cd NEWCTFILE NewCatalog.ct prog_cat.c=C_c_V21.sd

liest die Katalogbeschreibungsdatei ‘Prog.cd’ und erzeugt daraus die Katalog�bersetzungsdatei ‘NewCatalog.ct’ sowie den Quelltext ‘prog_cat.c’. Letzterer entspricht der Quelltextbeschreibungsdatei ‘C_c_V21.sd’. Der Basisname in der Quelltextbeschreibung ist ‘Prog’.(Beachten Sie die Gro�schreibung!)


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4 Aufbau einer Katalogbeschreibungsdatei

Eine Katalogbeschreibungsdatei enth�lt vier Arten von Zeilen.

Kommentarzeilen

Jede mit einem Semikolon beginnende Zeile ist eine Kommentarzeile, wird also von FlexCat ignoriert. (Eine Ausnahme sind die unten beschriebenen Stringzeilen, die sehr wohl mit einem Semikolon beginnen d�rfen.)

Kommandozeilen

Mit einem ’#’ beginnende Zeilen enthalten ein Kommando. M�gliche Kommandos sind (Gro�-/Kleinschreibung wird ignoriert):

#language <str>

gibt die Vorgabesprache des Programms an, d.h. die Sprache der Strings in der Katalogbeschreibungsdatei. Vorgabe ist ‘#language english’.

#version <num>

gibt die Versionsnummer der zu er�ffnenden Kataloge an. Im Unterschied zu Exec.OpenLibrary mu� die Nummer genau stimmen, h�here Nummern werden nicht akzeptiert. Eine Ausnahme ist es, hier die 0 als Versionsnummer anzugeben, durch die jeder Katalog akzeptiert wird. Vorgabe ist ‘#version 0’. Zu diesen Befehlen siehe auch Locale.OpenCatalog.

#lengthbytes <num>

Weist das Programm an, vor jeden String die angegebene Zahl von Bytes zu schreiben, die die L�nge des Strings (ohne die lengthbytes) enthalten und ohne abschlie�endes NUL-Byte angeben. (Ein NUL-Byte wird in Katalogen aber trotzdem angeh�ngt, im erzeugten Quelltext ist dies von der Quelltextbeschreibungsdatei abh�ngig.) ‘<num>’ mu� <= sizeof(long), d.h. <= 4 sein. Vorgabe ist ‘#lengthbytes 0’.

#basename <str>

Setzt den Basisnamen f�r die Quelltextbeschreibung. Der aus den Argumenten beim Aufruf des Programmnamens gewonnene Basisname (see section Aufruf des Programms) wird �berschrieben. See section Aufbau einer Quelltextbeschreibungsdatei.

Beschreibungszeilen

deklarieren einen String. Sie haben die Form ‘IDSTR (id/minlen/maxlen)’, wobei ‘IDSTR’ ein Bezeichner ist (d.h. ein aus den Zeichen a-z,A-Z,0-9 und dem Underscore bestehender String), ‘id’ eine eindeutige Nummer (die von jetzt an als ID bezeichnet wird) angibt, ‘minlen’ die minimale und ‘maxlen’ die maximale L�nge des Strings. Die drei letztgenannten d�rfen auch fehlen, das Programm w�hlt dann selbst einen Wert f�r ‘id’ und erlaubt Strings beliebiger L�nge. Die auf eine Beschreibungszeile folgende ist eine

Stringzeile,

d.h. sie enth�lt den eigentlichen String und nichts anderes. Dieser darf eine Reihe von Steuerzeichen enthalten, die alle durch einen Backslash eingeleitet werden:

\b

Backspace (Ascii 8)

\c

Control Sequence Introducer (Ascii 155)

\e

Escape (Ascii 27)

\f

Form Feed (Ascii 12)

\g

Display beep (Ascii 7)

\n

Line Feed, newline (Ascii 10)

\r

Carriage Return (Ascii 13)

\t

Tab (Ascii 9)

\v

Vertical tab (Ascii 11)

\)

Das Klammer-Zu-Zeichen. (Dies ist evtl. innerhalb einer ‘%(..)’-Sequenz n�tig, siehe Aufbau einer Quelltextbeschreibungsdatei.)

\\

Der Backslash selbst.

\xHH

Das durch ‘HH’ gegebene Ascii-Zeichen, wobei ‘HH’ Hexziffern sind.

\OOO

Das durch ‘OOO’ gegebene Ascii-Zeichen, wobei ‘OOO’ Hexziffern sind.

Schlie�lich signalisiert ein einzelner Backslash am Zeilenende, da� die Zeile (und damit der String) auf der n�chsten Zeile fortgesetzt wird. Es ist dadurch m�glich, beliebig lange Strings zu definieren. (FlexCat ist lediglich durch das verf�gbare RAM eingeschr�nkt.)

Ein String wird also stets durch eine Beschreibungszeile und eine unmittelbar darauffolgende Stringzeile angegeben. Ein Beispiel w�re

    msgHello (/4/)
    Hello, this is english!\n

In diesem Beispiel fehlt die ID, wird also vom Programm festgesetzt. (Dies ist sicher der einfachste und beste Weg.) Die 4 gibt hier an, da� der in der n�chsten Zeile stehende String wenigstens 4 Zeichen enthalten soll, eine maximale L�nge fehlt.

Als ausf�hrlicheres Beispiel zum Aufbau einer Katalogbeschreibungsdatei kann die Datei ‘FlexCat.cd’ dienen.


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

5 Aufbau einer Katalog�bersetzungsdatei

Katalog�bersetzungsdateien entsprechen in ihrem Aufbau ganz und gar den Katalogbeschreibungsdateien. Nur sind auf den Kommandozeilen andere Kommandos erlaubt und die Beschreibungszeilen enthalten keine Angaben �ber ID sowie minimale oder maximale L�nge, da diese aus der Katalogbeschreibung entnommen werden. Selbstverst�ndlich sollte jeder String aus der Katalogbeschreibung auch in der Katalog�bersetzung vorkommen und es d�rfen keine Strings (d.h. Stringbezeichner) auftauchen, die nicht auch in der Katalogbeschreibung definiert sind. Dies zu sichern geht am einfachsten, indem man mit FlexCat aus den evtl. ge�nderten Katalogbeschreibungen und den evtl. alten Katalog�bersetzungen neue erzeugt. See section Aufruf des Programms.

Die in Katalog�bersetzungsdateien erlaubten Kommandos sind:

##version <str>

Gibt die Version des Kataloges in Form eines AmigaDOS-Versionsstrings an. Beispiel:

##version $VER: Deutsch.ct 8.1 (27.09.93)

Die Versionsnummer dieses Kataloges ist 8. Um ihn zu er�ffnen, m�ssten also in der Katalogbeschreibung die Versionsnummern 0 oder 8 angegeben werden.

##language <str>

Gibt die Sprache des Kataloges an. Nat�rlich sollte dies eine andere als die Sprache der Katalogbeschreibung sein. Die Katalogsprache und die Katalogversion m�ssen angegeben werden.

##codeset <num>

Ein derzeit noch unbenutztes Argument f�r die Er�ffnung eines Kataloges. Sollte immer 0 sein. (Dies ist auch der Vorgabewert.)

Das obige Beispiel sieht hier so aus:

    msgHello
    Hallo, dies ist deutsch!\n

Als weiteres Beispiel einer Katalog�bersetzungsdatei kann ‘Deutsch.ct’ dienen.


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

6 Aufbau einer Quelltextbeschreibungsdatei

Der wichtigste Teil von FlexCat ist die Quelltexterzeugung. Bis hierher bietet FlexCat nichts, was nicht auch CatComp, KitCat und Konsorten bieten w�rden. Der erzeugte Quelltext soll nun die Verwendung der erzeugten Kataloge m�glichst einfach machen. Andererseits soll dies aber unter beliebigen Programmiersprachen und f�r beliebige Anforderungen gelten. Um diese scheinbaren Widerspr�che aufzul�sen, kennt FlexCat die Quelltextbeschreibungsdateien. Das sind Dateien, die gewisserma�en die Vorlage f�r den zu erzeugenden Quelltext bilden. Wie die Katalogbeschreibungs- und die -�bersetzungsdateien sind sie mit einem Editor erzeug- und bearbeitbar: Das ist es, was FlexCat so flexibel macht.

FlexCat durchsucht die Quelltextbeschreibung nach gewissen Symbolen, die durch die in der Katalogbeschreibung gegebenen Werte ersetzt werden. M�gliche Symbole sind zum einen die mit einem Backslash eingeleiteten Steuerzeichen, die auch in den Strings der Katalogbeschreibung und der Katalog�bersetzung erlaubt sind, zum anderen aber Steuerzeichen, die mit einem <%>-Zeichen beginnen: F�r C-Programmierer ein wohlvertrautes Konzept. M�gliche Steuerzeichen sind:

%b

ist der Basisname der Quelltextbeschreibungsdatei. (F�r ‘FlexCat.cd’ als CDFILE w�re also FlexCat der Basisname. Wie schon erw�hnt, kommt es deshalb beim Argument CDFILE sehr wohl auf Gro�-/Kleinschreibung an; see section Aufruf des Programms)

%v

ist die Versionsnummer aus der Katalogbeschreibung, nicht zu verwechseln mit dem Versionsstring aus der Katalog�bersetzung.

%l

ist die Sprache der Katalogbeschreibung. Bitte beachten Sie, da� hier ein String eingesetzt wird, dessen Aussehen mit dem Kommando ##stringtype beeinflu�t wird.

%n

ist die Anzahl der Strings in der Katalogbeschreibung.

%%

ist das Prozentzeichen selbst.

Das wesentlichste sind aber die folgenden Steuerzeichen. Sie repr�sentieren auf unterschiedliche Art und Weise die Strings der Katalogbeschreibung. Zeilen die eines dieser Zeichen enthalten, werden von FlexCat f�r jeden Katalogstring wiederholt, da im Normalfall kaum alle Strings in eine Zeile passen w�rden.

%i

ist der Bezeichner aus der Katalogbeschreibung.

%d

ist die ID des Strings

%s

ist der String selbst; dieser wird in einer von der Programmiersprache abh�ngigen Art und Weise dargestellt. Dies kann mit den Kommandos ##stringtype und ##shortstrings beeinflu�t werden.

%(...)

gibt an, da� der zwischen den Klammern stehende Text bei allen Strings au�er dem letzten auftauchen soll. Dies ist z.B. bei Arrays n�tzlich, wenn unterschiedliche Arrayeintr�ge durch ein Komma getrennt werden sollen, nach dem letzten aber kein Komma mehr kommen soll: Dann w�rde man nach dem Stringeintrag eben ‘%(,)’ schreiben. Beachten Sie, da� der Text zwischen den Klammern nicht weiter auf ‘%’-Symbole untersucht wird. Backslash-Sequenzen sind allerdings weiter erlaubt.

Die Steuerzeichen ‘%l’ und ‘%s’ erzeugen Strings. Die Darstellung von Strings h�ngt nat�rlich von der Programmiersprache ab, f�r die Quelltext erzeugt werden soll. Deshalb k�nnen in die Quelltextbeschreibung �hnlich wie in der Katalog�bersetzung Kommandos eingebaut werden. Diese m�ssen am Zeilenanfang stehen und jeweils eine eigene Zeile einnehmen. Die m�glichen Kommandos sind:

##shortstrings

gibt an, da� lange Strings �ber mehrere Zeilen verteilt werden d�rfen. Dies ist nicht in allen Programmiersprachen ohne weiteres m�glich und vor allem besonders stark von der verwendeten Programmiersprache abh�ngig. Deshalb werden vorgabem��ig notfalls eben sehr lange Zeilen erzeugt.

##stringtype <art>

gibt die Syntax der Strings an. M�gliche Arten sind:

None

Es werden keinerlei zus�tzliche Zeichen erzeugt und lediglich die Zeichen des Strings ausgegeben. Es ist keine Ausgabe von Bin�rzeichen (das sind die mit dem Backslash erzeugten Zeichen) m�glich.

C

erzeugt Strings gem�� den Regeln der Programmiersprache C, d.h. die Strings werden links und rechts mit je einem Anf�hrungszeichen abgegrenzt. Falls Strings �ber mehrere Zeilen verteilt werden, so werden die Zeilen bis auf die letzte mit einem Backslash beendet. (Der Backslash ist innerhalb von Makros n�tig.) Steuerzeichen werden mit ‘\OOO’ ausgegeben. See section FlexCat-Quelltext in C-Programmen.

Oberon

wie der Stringtyp bei C, allerdings wird kein Backslash bei Zeilentrennung erzeugt. See section FlexCat-Quelltext in Oberon-Programmen.

Assembler

Strings werden mit ‘dc.b’ erzeugt und links und rechts mit einem einfachen Anf�hrungsstrich abgegrenzt. Bin�rzeichen werden mit $XX erzeugt. See section FlexCat-Quelltext in Assembler-Programmen.

Als Beispiel betrachten wir einen Auszug aus der Quelltextbeschreibungsdatei ‘C_h.sd’, die eine Include-Datei f�r die Programmiersprache C erzeugt:

##stringtype C
##shortstrings

#ifndef %b_CAT_H    /*	Sicherstellen, da� Include-Datei    */
#define %b_CAT_H    /*	nur einmal verwendet wird.	    */


#ifndef EXEC_TYPES_H		/*  N�tige andere Include-  */
#include <exec/types.h> 	/*  Dateien einbinden.	    */
#endif
#ifndef LIBRARIES_LOCALE_H
#include <libraries/locale.h>
#endif


/*  Prototypen	*/
extern void Open%bCatalog(struct Locale *, STRPTR);
extern void Close%bCatalog(void);
extern STRPTR Get%bString(LONG);

/*  Definitionen der Bezeichner und ihrer ID's              */
#define %i %d	/*  Diese Zeile wird f�r jeden Katalog-     */
		/*  wiederholt. 			    */

#endif

[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

7 Einbau des erzeugten Quelltextes in eigene Pro\-gram\-me

Wie der Quelltext benutzt wird, h�ngt nat�rlich vom erzeugten Quelltext und damit von den jeweiligen Quelltextbeschreibungen ab. See section Aufbau einer Quelltextbeschreibungsdatei. Es kann hier deshalb nur auf die mit FlexCat mitgelieferten Quelltextbeschreibungsdateien eingegangen werden.

Alle diese Dateien sind so aufgebaut, da� das fertige Programm auf jeden Fall auch ohne die locale.library arbeitet. Allerdings mu� es eine globale Variable ‘LocaleBase’ (d.h. ‘_LocaleBase’ f�r Assembler-Programmierer) geben und diese mu� mit ‘NULL’ oder durch einen Aufruf von Exec.OpenLibrary initialisiert sein. Im ersten Fall werden nat�rlich nur die eingebauten Strings aus der Katalogbeschreibung verwendet. Eine Ausnahme stellt die Quelltextbeschreibung ‘C_c_V20.sd’ dar, die auch unter der Workbench 2.0 Lokalisierung erm�glicht, indem sie evtl. die locale.library durch die iffparse.library ersetzt. (Diese Version ben�tigt dann auch eine Variable ‘IFFParseBase’ f�r die das gleiche wie f�r ‘LocaleBase’ gilt.) See section FlexCat-Quelltext in C-Programmen. Als Programmierer ben�tigen Sie keinerlie Kenntnisse dieser Libraries, au�er Sie wollen eigene Quelltextbeschreibungen erzeugen.

Es gibt lediglich 3 Funktionen, die aufzurufen recht simpel ist:

: OpenCatalog (locale, language)

Diese Funktion versucht, einen Katalog zu er�ffnen. Das Argument locale ist ein Zeiger auf eine Locale-Struktur, language ein Zeiger auf einen String, der den Namen der gew�nschten Sprache enth�lt. Beide Argumente werden an die Locale-Funktion OpenCatalog �bergeben und sollten normalerweise immer NULL (bzw. NIL) sein, da andernfalls die Voreinstellungen des Benutzers �berschrieben werden. N�heres ist in den AutoDocs nachzulesen.

Hat der Benutzer als Vorgabesprachen etwa ‘Deutsch’ und ‘Francais’ eingestellt und der Basisname des Programms ist ‘XXX’, so wird nacheinander nach folgenden Dateien gesucht:

PROGDIR:Catalogs/Deutsch/XXX.catalog’
    ‘LOCALE:Catalogs/Deutsch/XXX.catalog’
    ‘PROGDIR:Catalogs/Francais/XXX.catalog’
    ‘LOCALE:Catalogs/Francais/XXX.catalog

Dabei ist ‘PROGDIR:’ das aktuelle Directory des Programms. Die Reihenfolge von ‘PROGDIR:’ und ‘LOCALE:’ kann evtl. vertauscht werden, falls dadurch ein Requester wie ‘Insert volume YYY’ unterdr�ckt werden kann.

OpenCatalog ist vom Typ void (f�r Modula2-Programmierer: Eine Prozedur), liefert also kein Ergebnis.

: GetString (ID)

Ist der Katalog er�ffnet, so erh�lt man mit dieser Funktion einen Zeiger auf den Katalogstring mit der angegebenen Nummer. Die ID wird in der Katalogbeschreibung definiert. Es versteht sich von selbst, da� die Strings Eigentum der locale.library sind und deshalb nicht ver�ndert werden d�rfen.

Ein Beispiel ist vielleicht n�tzlich. Im Beispiel aus der Katalogbeschreibung wird der String msgHello definiert. Die Quelltextbeschreibungen deklarieren nun eine Konstante ‘msgHello’, der die ID repr�sentiert. Damit k�nnte der String in C so ausgegeben werden:

    printf("%s\n", GetString(msgHello));
: CloseCatalog (void)

Mit dieser Funktion wird der Katalog (das hei�t das belegte RAM) vor dem Programmende wieder freigegeben. Die Funktion kann gefahrlos zu jeder Zeit aufgerufen werden, sogar wenn OpenCatalog gar nicht aufgerufen wurde.


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

7.1 FlexCat-Quelltext in C-Programmen

Der C-Quelltext besteht aus zwei Teilen: Einer ‘.c’-Datei, die einfach �bersetzt und mit dem Linker eingebunden wird und nicht weiter zu interessieren braucht und einer ‘.h’-Datei, die vom benutzenden Programm mit ‘#include’ eingebunden wird. In ihr werden die ID’s der Strings als Makro definiert.

Dabei gibt es zwei unterschiedliche Versionen: ‘C_c_V21.sd’ und ‘C_h_V21.sd’ sind recht simple Versionen, die einfach die entsprechenden Funktionen der locale.library benutzen. Dementsprechend ist mit ihnen Lokalisierung ab Workbench 2.1 m�glich. Dagegen ersetzen ‘C_c_V20.sd’ und ‘C_h_V20.sd’ unter 2.0 evtl. die locale.library durch die iffparse.library. Das setzt allerdings voraus, da� das Programm eine Option Language besitzt, die die Wahl einer Sprache erm�glicht und deren Wert dann an ‘OpenCatalog’ �bergeben wird. Unter 2.1 oder h�her sollte diese Option nicht benutzt werden.

Es w�re prinzipiell durchaus denkbar, auch eine dritte Version zu schreiben, die Lokalisierung sogar unter 1.3 erm�glicht, aber das habe ich nicht getan, da ich 1.3 nicht mehr unterst�tzen m�chte.

Um die FlexCat-Funktionen OpenCatalog und CloseCatalog von den gleichnamigen Locale-Funktionen zu unterscheiden und um theoretisch auch das gleichzeitige Er�ffnen mehrerer Kataloge zu erm�glichen, tragen die FlexCat-Funktionen etwas ge�nderte Namen, n�mlich ‘OpenXXXCatalog’, ‘CloseXXXCatalog’ und ‘GetXXXString’. Dabei ist ‘XXX’ der Basisname aus der Quelltextbeschreibung. Das Konzept ist von der GadToolsBox �bernommen und meines Erachtens bew�hrt. See section Aufbau einer Quelltextbeschreibungsdatei.

Die Prototypen der Funktionen sind:

    void OpenXXXCatalog(struct Locale *loc, char *language);
    STRPTR GetXXXString(ULONG);
    void CloseXXXCatalog(void);

Zum Schlu� noch ein Beispiel eines Programms, das FlexCat verwendet.

    #include <stdio.h>
    #include <stdlib.h>
    #include <XXX.h>	    /*	Diese Include-Datei unbedingt	*/
			    /*	einbinden!			*/
    #include <clib/exec_protos.h>

    struct Library *LocaleBase;
    /*	Library auf jeden Fall selber er�ffnen, auch wenn der	*/
    /*	Compiler das automatisch kann!				*/

    void main(int argc, char *argv[])

    {
      LocaleBase = OpenLibrary("locale.library", 38);
      /*  KEIN Abbruch, falls OpenLibrary() nicht erfolg-       */
      /*  reich! (Nat�rlich nur, wenn Locale-Funktionen nicht   */
      /*  anderweitig benutzt werden.				*/
      OpenXXXCatalog(NULL, NULL);

      ...   /*	andere Funktionen	    */

      printf("%s\n", GetXXXString(msgHello));

      ...   /*	nochmal andere Funktionen   */

      CloseXXXCatalog();
      if (LocaleBase)
	  CloseLibrary(LocaleBase);
    }

[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

7.2 FlexCat-Quelltext in Oberon-Programmen

Es gibt zwei unterschiedliche Quelltextbeschreibungen: ‘Oberon_V38.sd’ erzeugt Quelltext, der ‘Locale.mod’ von Hartmut Goebel verwendet. Der mit ‘Oberon_V39.mod’ erzeugte Quelltext ben�tigt dagegen das beim AmigaOberon mitgelieferte ‘Locale.mod’.

Die Prototypen der Funktionen sind:

    XXX.OpenCatalog(loc: Locale.LocalePtr; language : ARRAY OF CHAR);
    XXX.GetString(num: LONGINT): Exec.StrPtr;
    XXX.CloseCatalog();

Dabei ist ‘XXX’ jeweils der Basisname aus der Quelltextbeschreibung. See section Aufbau einer Quelltextbeschreibungsdatei.

Zum Schlu� noch ein Beispiel eines Programms, das den von FlexCat erzeugten Quelltext verwendet:

    MODULE Irgendwas;

    IMPORT  x:=XXX; Dos;

    BEGIN
      x.OpenCatalog(NIL, "");

      ... (* Irgendwelche anderen Funktionen. *)

      Dos.PrintF("%s\n", x.GetString(x.msgHello));

      ... (* Nochmal irgendwelche anderen Funktionen.   *)
	  (* Katalog wird beim Programmende automatisch *)
	  (* geschlossen.                               *)
    END Irgendwas;

[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

7.3 FlexCat-Quelltext in Assembler-Programmen

Der Assembler-Quelltext erzeugt Code f�r den Aztec-Assembler. Dieser d�rfte sich aber kaum wesentlich von anderen verbreiteten Assemblern unterscheiden und es sollte ohne gro�e Probleme m�glich sein, daraus eine eigene Quelltextbeschreibung zu machen. Der Quelltext besteht aus zwei Teilen: Einer ‘.asm’-Datei, die einfach �bersetzt und mit dem Linker eingebunden wird und nicht weiter zu interessieren braucht und einer ‘.i’-Datei, die vom benutzenden Programm mit ‘include’ eingebunden wird. In ihr werden die ID’s der Strings definiert.

Um theoretisch auch das gleichzeitige Er�ffnen mehrerer Kataloge zu erm�glichen, tragen die FlexCat-Funktionen etwas ge�nderte Namen, n�mlich ‘OpenXXXCatalog’, ‘CloseXXXCatalog’ und ‘GetXXXString’. Dabei ist ‘XXX’ der Basisname aus der Quelltextbeschreibung. Das Konzept ist von der GadToolsBox �bernommen und meines Erachtens bew�hrt. See section Aufbau einer Quelltextbeschreibungsdatei.

Die Funktionen liefern wie �blich das Ergebnis in d0 und sichern die Register d2-d7 und a2-a7. OpenCatalog erwartet seine Argumente in a0 (Zeiger auf Locale-Struktur) und in a1 (Zeiger auf String mit zu verwendender Sprache). Wie schon erw�hnt, sollten diese Argumente im Normalfall immer NULL sein. GetString erwartet in d0 eine ID.

Zum Schlu� noch ein Beispiel eines Programms, das FlexCat verwendet.

	include "XXX.i" /*  Enth�lt xref OpenXXXCatalog usw.   */

	xref	_LVOOpenLibrary
	xref	_LVOCloseLibrary
	xref	_AbsExecBase

	dseg
LocNam: dc.b	"locale.library",0
	dc.l	_LocaleBase,4	    ; Dieser Name ist obligatorisch

	cseg

main:	move.l	#38,d0		    ; Locale er�ffnen
	lea	LocName,a1
	move.l	_AbsExecBase.a6
	jsr	_LVOOpenLibrary(a6)
*  KEIN Abbruch, falls OpenLibrary() nicht erfolgreich! (Nat�rlich nur,
*   wenn Locale-Funktionen nicht anderweitig benutzt werden.

	move.l	#0,a0
	move.l	#0,a1
	jsr	OpenXXXCatalog	    ; Katalog er�ffnen

	...			    ; andere Funktionen

	move.l	#msgHello,d0	    ; Zeiger auf String holen
	jsr	GetXXXString
	jsr	PrintD0 	    ; und ausgeben

	...			    ; nochmal andere Funktionen

Ende:
	jsr	CloseXXXCatalog     ; Katalog schlie�en
	move.l	_LocaleBase,a1	    ; Locale evtl. schlie�en
	move.l	a1,d0
	beq	Ende1
	jsr	CloseLibrary
Ende1:
	rts
	end

[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

Weiterentwicklung des Programms

Ich beabsichtige eigentlich nicht, das Programm wesentlich weiterzuentwickeln, denke auch nicht, da� das n�tig sein wird, bin aber nat�rlich trotzdem f�r jegliche Anregung, Vorschl�ge oder notfalls auch Kritik offen. Was ich auf jeden Fall gerne machen werde, sind andere Stringtypen, falls sich diese f�r andere Programmiersprachen als notwendig erweisen sollten.

Ferner w�re ich auf jeden Fall dankbar f�r weitere Quelltextbeschreibungen und w�rde diese gerne in einer sp�teren Version �ffnetlich zug�nglich machen - egal, welche Programmiersprache oder mit welchen Erweiterungen. Voraussetzung ist nat�rlich, da� der von diesen Quelltextbeschreibungen erzeugte Code in einem laufenden Programm erfolgreich erprobt wurde.

Ebenso dankbar w�re ich nat�rlich auch f�r neue Kataloge. Es gen�gt der Eintrag der entsprechenden Strings in der Datei ‘NewCatalogs.ct’. Wie das geht, sollte nach der Lekt�re dieser Dokumentation hoffentlich klar sein.


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

Danksagungen

Danken m�chte ich:

Albert Weinert

f�r KitCat, den Vorg�nger von FlexCat, der mir gute Dienste geleistet hat, aber irgendwann eben nicht flexibel genug war.

Reinhard Spisser und Sebastiano Vigna

f�r die Amiga-Version von texinfo, mit der diese Dokumentation geschrieben ist.

Der Free Software Foundation

f�r die Urversion von texinfo und f�r viele andere hervorragende Programme.

Matt Dillon

f�r DICE und besonders f�r DME.

Alessandro Galassi

f�r den italienischen Katalog.

Den Leuten von #AmigaGer

f�r die Beantwortung vieler dummer Fragen und f�r viele Augenblicke erfreulich ungez�gelten Schwachsinns :-), z.B. PowerStat (Kai Hoffmann), ZZA (Bernhard M�llemann), Stargazer (Petra Zeidler), stefanb (Stefan Becker), Tron (Mathias Scheler), ill (Markus Illenseer).

Commodore

f�r den Amiga und f�r die Kickstart 2.0 :-) Macht weiter mit der Kiste, dann bin ich vielleicht auch die n�chsten 8 Jahre Amiga-Benutzer!


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

Index

Jump to:   .    
A   B   C   D   F   I   K   O   P   Q   S   W   Z  
Index Entry  Section

.
.cd 4 Aufbau einer Katalogbeschreibungsdatei
.ct 5 Aufbau einer Katalog�bersetzungsdatei
.sd 6 Aufbau einer Quelltextbeschreibungsdatei

�bersicht 1 �bersicht

A
Ascii-Code 4 Aufbau einer Katalogbeschreibungsdatei
Assembler 7.3 FlexCat-Quelltext in Assembler-Programmen
AztecAs_asm.sd 7.3 FlexCat-Quelltext in Assembler-Programmen
AztecAs_i.sd 7.3 FlexCat-Quelltext in Assembler-Programmen

B
Beitr�ge Weiterentwicklung des Programms
Benutzung 7 Einbau des erzeugten Quelltextes in eigene Pro\-gram\-me

C
C 7.1 FlexCat-Quelltext in C-Programmen
Catalog description 4 Aufbau einer Katalogbeschreibungsdatei
Catalog translation 5 Aufbau einer Katalog�bersetzungsdatei
Compiler 1 �bersicht
C_c_V20.sd 7.1 FlexCat-Quelltext in C-Programmen
C_c_V21.sd 7.1 FlexCat-Quelltext in C-Programmen
C_h.sd 7.1 FlexCat-Quelltext in C-Programmen

D
Danksagungen Danksagungen
Deutsch.ct 5 Aufbau einer Katalog�bersetzungsdatei

F
FlexCat.cd 4 Aufbau einer Katalogbeschreibungsdatei

I
Installation 2 Installation des Programms

K
Katalogbeschreibung 4 Aufbau einer Katalogbeschreibungsdatei
Katalog�bersetzung 5 Aufbau einer Katalog�bersetzungsdatei

O
Oberon 7.2 FlexCat-Quelltext in Oberon-Programmen
Oberon_V38.sd 7.2 FlexCat-Quelltext in Oberon-Programmen
Oberon_V39.sd 7.2 FlexCat-Quelltext in Oberon-Programmen

P
Programmiersprache 1 �bersicht

Q
Quelltextbeschreibung 6 Aufbau einer Quelltextbeschreibungsdatei

S
Source description 6 Aufbau einer Quelltextbeschreibungsdatei
Steuerzeichen 4 Aufbau einer Katalogbeschreibungsdatei
Systemanforderungen 2 Installation des Programms

W
Weiterentwicklung Weiterentwicklung des Programms

Z
Zukunft Weiterentwicklung des Programms

Jump to:   .    
A   B   C   D   F   I   K   O   P   Q   S   W   Z  

[Top] [Contents] [Index] [ ? ]

Table of Contents


[Top] [Contents] [Index] [ ? ]

About This Document

This document was generated on September 19, 2022 using texi2html 5.0.

The buttons in the navigation panels have the following meaning:

Button Name Go to From 1.2.3 go to
[ << ] FastBack Beginning of this chapter or previous chapter 1
[ < ] Back Previous section in reading order 1.2.2
[ Up ] Up Up section 1.2
[ > ] Forward Next section in reading order 1.2.4
[ >> ] FastForward Next chapter 2
[Top] Top Cover (top) of document  
[Contents] Contents Table of contents  
[Index] Index Index  
[ ? ] About About (help)  

where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure:


This document was generated on September 19, 2022 using texi2html 5.0.