File: interface-dynlibs.de.tm

package info (click to toggle)
texmacs 1%3A2.1.4%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 145,076 kB
  • sloc: cpp: 227,393; lisp: 197,386; ansic: 5,395; python: 1,939; makefile: 1,065; sh: 781; perl: 339; xml: 100; awk: 36
file content (249 lines) | stat: -rw-r--r-- 7,582 bytes parent folder | download | duplicates (3)
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<TeXmacs|1.0.4.2>

<style|tmdoc>

<\body>
  <tmdoc-title|Dynamisch ladbare Bibliotheken>

  Die Kommunikation zwischen <TeXmacs> und einer Anwendung kann auer ber
  eine \RPipeline`` auch dadurch erfolgen, dass die Anwendung als
  \Rdynamically linked library'', DLL, eingebunden wird. \ Pipelines sind
  meist leichter zu implementieren, oft sehr robust und flexibel in Bezug auf
  Daten, die nur nach und nach erzeugt werden. Aber DLLs sind schneller.

  Um eine Anwendung dynamisch mit <TeXmacs> zu linken, sollten Sie dem
  <TeXmacs> Kommunikations-Protokoll folgen, das in folgenden Datei

  <\verbatim>
    \ \ <hlink|include/TeXmacs.h|../../../../../include/TeXmacs.h> \ 
  </verbatim>

  definiert ist.

  Darin ist spezifiziert, dass die Anwendung folgende Datenstruktur
  exportieren soll:

  <\cpp-fragment>
    typedef struct package_exports_1 {

    \ \ char* version_protocol; /* "TeXmacs communication protocol 1" */

    \ \ char* version_package;

    \ \ char* (*install) (TeXmacs_exports_1* TeXmacs,

    \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ char* options, char** errors);

    \ \ char* (*evaluate) (char* what, char* session, char** errors);

    } package_exports_1;
  </cpp-fragment>

  Sie enthlt sowohl eine Installationsroutine fr die Anwendung als auch
  eine Evaluierungsroutinen fr zustzliche Eingabe. (Mehr Informationen
  finden Sie in der Datei \ <hlink|include/TeXmacs.h|../../../../../include/TeXmacs.h>).
  <TeXmacs> exportiert folgende Struktur:

  <\cpp-fragment>
    typedef struct TeXmacs_exports_1 {

    \ \ char* version_protocol; /* "TeXmacs communication protocol 1" */

    \ \ char* version_TeXmacs;

    } TeXmacs_exports_1;
  </cpp-fragment>

  Jedes Programm hat fr sein Speicher-Management selbst zu sorgen.
  Zeichenketten, die \ <TeXmacs> erzeugt, mssen von <TeXmacs> gelscht
  werden. Das gilt entsprechend fr die Anwendung.

  Die Zeichenkette <verbatim|version_protocol> sollte <verbatim|\RTeXmacs
  communication protocol 1"> und die Zeichenkette <verbatim|version_package>
  die Version Ihrer Anwendung enthalten.

  Die Funktion <verbatim|install> wird ein einziges Mal von <TeXmacs> mit den
  Optionen <verbatim|options> aufgerufen, um Ihre Anwendung zu
  initialisieren. Es bertrgt die Routinen, die von <TeXmacs> exportiert
  werden, als <verbatim|TM>. Diese Routine sollte, sofern erfolgreich, eine
  Statusmeldung zurckgeben, z.B.:

  <\verbatim>
    \ \ \ \ "Ihre CAS-Version wurde erfolgreich in TeXmacs eingebunden"
  </verbatim>

  Wenn die Installation ohne Erfolg blieb, sollten Sie <verbatim|NULL>
  zurckgeben und <verbatim|*errors> sollte eine erklrende Meldung
  enthalten.\ 

  Die <verbatim|evaluate>-Funktion dient zur Evaluierung von <verbatim|what>
  in einer <TeXmacs>-Sitzung mit dem Namen <verbatim|session>. Sie sollte das
  Ergebnis der Evaluierung von <verbatim|what> zurckgeben, falls
  erfolgreich, oder <verbatim|NULL>, wenn ein Fehler auftrat.
  <verbatim|*errors> kann, je nach Verlauf der Evaluierung, eine oder mehrere
  Warnungen enthalten oder eine Fehlermeldung, wenn die Evaluierung versagte.
  Die Formate sind die gleichen wie im Fall der Kommunikation ber Pipelines.

  Schlielich sollte die Konfigurations-Datei des Plugins noch so etwas wie
  das folgende enthalten:

  <\scheme-fragment>
    (plugin-configure <em|myplugin>

    \ \ (:require (url-exists? (url "$LD_LIBRARY_PATH"
    "lib<em|myplugin>.so")))

    \ \ (:link "lib<em|myplugin>.so" "<em|myplugin>_exports" "")

    \ \ <em|further-configuration>)
  </scheme-fragment>

  Hier ist <verbatim|<em|myplugin>_exports> ein Zeiger auf eine Struktur vom
  Typ \ <cpp-code|package_exports_1>.

  <\remark>
    Es ist mglich, dass das Kommunikations-Protokoll sich ndert. In diesem
    Fall werden die Daten-Strukturen <verbatim|TeXmacs_exports_1> und
    <verbatim|package_exports_1> durch <verbatim|TeXmacs_exports_n> und
    <verbatim|package_exports_n> ersetzt, worin n die Version des Protokolls
    ist. Diese Strukturen werden immer die abstrakten Strukturen
    <verbatim|TeXmacs_exports> und <verbatim|package_exports> behalten, in
    denen die Informationen ber die Protokoll-, <TeXmacs>- und
    Anwendungs-Version, enthalten sind.
  </remark>

  <paragraph*|Das <verbatim|dynlink> plugin>

  Das Beispiel Plugin <verbatim|dynlink> zeigt, wie dynamisch ladbare
  Bibliotheken geschrieben und benutzt werden. Es besteht aus den Dateien:

  <\verbatim>
    \ \ \ \ <example-plugin-link|dynlink/Makefile>

    \ \ \ \ <example-plugin-link|dynlink/progs/init-dynlink.scm>

    \ \ \ \ <example-plugin-link|dynlink/src/dynlink.cpp>
  </verbatim>

  Das <verbatim|Makefile> enthlt die Zeilen

  <\quotation>
    <\framed-fragment>
      <\with|par-par-sep|0fn>
        <\with|font-family|tt>
          tmsrc = /home/vdhoeven/texmacs/src/TeXmacs

          CXX = g++

          LD \ = g++

          \;

          lib/libtmdynlink.so: src/dynlink.cpp

          \ \ \ \ \ \ \ \ $(CXX) -I$(tmsrc)/include -c src/dynlink.cpp -o
          src/dynlink.o

          \ \ \ \ \ \ \ \ $(LD) -shared -o lib/libtmdynlink.so src/dynlink.o
        </with>
      </with>
    </framed-fragment>
  </quotation>

  so dass <verbatim|dynlink.cpp> zu einer dynamisch linkbaren Datei (DLL)
  <verbatim|dynlink/lib/libdynlink.so> kompiliert wird. Die <verbatim|tmsrc>
  Variable sollte so gesetzt sein, dass die include-Datei
  <verbatim|TeXmacs.h> gefunden wird. Die Konfigurations-Datei
  <verbatim|init-dynlink.scm> enthlt die folgenden Zeilen

  <\scheme-fragment>
    (plugin-configure dynlink

    \ \ (:require (url-exists? (url "$LD_LIBRARY_PATH"

    \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ "libtmdynlink.so")))

    \ \ (:link "libtmdynlink.so" "dynlink_exports" "")

    \ \ (:session "Dynlink"))
  </scheme-fragment>

  Die <value|cpp> Datei <verbatim|dynlink.cpp> enthlt die Zeichenkette

  <\cpp-fragment>
    static char* output= NULL;
  </cpp-fragment>

  mit der letzten Ausgabe, die Initialisierungs-Routine

  <\cpp-fragment>
    char*

    dynlink_install (TeXmacs_exports_1* TM, char* opts, char** errs) {

    \ \ output= (char*) malloc (50);

    \ \ strcpy (output, "\\2verbatim:Started dynamic link\\5");

    \ \ return output;

    }
  </cpp-fragment>

  die Evaluierungs-Routine

  <\cpp-fragment>
    char*

    dynlink_eval (char* what, char* session, char** errors) {

    \ \ free (output);

    \ \ output= (char*) malloc (50 + strlen (what));

    \ \ strcpy (output, "\\2verbatim:You typed ");

    \ \ strcat (output, what);

    \ \ strcat (output, "\\5");

    \ \ return output;

    }
  </cpp-fragment>

  und die Daten-Struktur den Exporten

  <\cpp-fragment>
    package_exports_1 dynlink_exports= {

    \ \ "TeXmacs communication protocol 1",

    \ \ "Dynlink 1",

    \ \ dynlink_install,

    \ \ dynlink_eval

    };
  </cpp-fragment>

  Beachten Sie bitte, dass bei der Ausgabe die Anwendung fr die Reservierung
  und die Freigabe von Speicher zu sorgen hat.

  <tmdoc-copyright|1998--2002|Joris van der Hoeven>

  <tmdoc-license|Permission is granted to copy, distribute and/or modify this
  document under the terms of the GNU Free Documentation License, Version 1.1
  or any later version published by the Free Software Foundation; with no
  Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  Texts. A copy of the license is included in the section entitled "GNU Free
  Documentation License".>
</body>

<\initial>
  <\collection>
    <associate|language|german>
    <associate|preamble|false>
  </collection>
</initial>