Debian Codegraph @

cextern/xpa/man/mann/xpaconvert.n

raw
1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 . de IX
53 . tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 . nr % 0
56 . rr F
57 .\}
58 .el \{\
59 . de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
66 .if n \{\
67 . ds #H 0
68 . ds #V .8m
69 . ds #F .3m
70 . ds #[ \f1
71 . ds #] \fP
72 .\}
73 .if t \{\
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 . ds #V .6m
76 . ds #F 0
77 . ds #[ \&
78 . ds #] \&
79 .\}
80 . \" simple accents for nroff and troff
81 .if n \{\
82 . ds ' \&
83 . ds ` \&
84 . ds ^ \&
85 . ds , \&
86 . ds ~ ~
87 . ds /
88 .\}
89 .if t \{\
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 . ds : e
114 . ds 8 ss
115 . ds o a
116 . ds d- d\h'-1'\(ga
117 . ds D- D\h'-1'\(hy
118 . ds th \o'bp'
119 . ds Th \o'LP'
120 . ds ae ae
121 . ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "xpaconvert n"
127 .TH xpaconvert n "July 23, 2013" "version 2.1.15" "SAORD Documentation"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 \&\fBXPAConvert: Converting the \s-1XPA\s0 \s-1API\s0 to 2.0\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 This document describes tips for converting from xpa 1.0 (Xt-based
137 xpa) to xpa 2.0 (socket-based xpa).
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 The following are tips for converting from xpa 1.0 (Xt-based xpa) to
141 xpa 2.0 (socket-based xpa). The changes are straight-forward and
142 almost can be done automatically (we used editor macros for most of
143 the conversion).
144 .IP "\(bu" 4
145 The existence of the cpp \s-1XPA_VERSION\s0 directive to distinguish between 1.0
146 (where it is not defined) and 2.0 (where it is defined).
147 .IP "\(bu" 4
148 Remove the first widget argument from all send and receive server
149 callbacks. Also change first 2 arguments from XtPointer to void
150 *. For example:
151 .Sp
152 #ifdef \s-1XPA_VERSION\s0
153 static void XPAReceiveFile(client_data, call_data, paramlist, buf, len)
154 void *client_data;
155 void *call_data;
156 char *paramlist;
157 char *buf;
158 int len;
159 #else
160 static void XPAReceiveFile(w, client_data, call_data, paramlist, buf, len)
161 Widget w;
162 XtPointer client_data;
163 XtPointer call_data;
164 char *paramlist;
165 char *buf;
166 int len;
167 #endif
168 .IP "\(bu" 4
169 Server callbacks should be declared as returning int instead
170 of void. They now should return 0 for no errors, \-1 for error.
171 .IP "\(bu" 4
172 The mode flags have changed when defining \s-1XPA\s0 server callbacks.
173 The old \fIS\fR flag (save buffer) is replaced by \fIfreebuf=false\fR.
174 The old \fIE\fR flag (empty buffer is \s-1OK\s0) is no longer used (it
175 was an artifact of the X implementation).
176 .IP "\(bu" 4
177 Change \fINewXPACommand()\fR to \fIXPAcmdNew()\fR, with the new calling sequence:
178 .Sp
179 .Vb 1
180 \& xpa = NewXPACommand(toplevel, NULL, prefix, NULL);
181 .Ve
182 .Sp
183 is changed to:
184 .Sp
185 .Vb 1
186 \& xpa = XPACmdNew(xclass, name);
187 .Ve
188 .IP "\(bu" 4
189 Change the \fIAddXPACommand()\fR subroutine name to XPACmdAdd (with the same
190 calling sequence):
191 .Sp
192 .Vb 3
193 \& AddXPACommand(xpa, "file",
194 \& "\etdisplay a new file\en\et\et requires: filename",
195 \& NULL, NULL, NULL, XPAReceiveFile, text, NULL);
196 .Ve
197 .Sp
198 is changed to:
199 .Sp
200 .Vb 3
201 \& XPACmdAdd(xpa, "file",
202 \& "\etdisplay a new file\en\et\et requires: filename",
203 \& NULL, NULL, NULL, XPAReceiveFile, text, NULL);
204 .Ve
205 .IP "\(bu" 4
206 The \fIXPAXtAppInput()\fR routine should be called just before \fIXtAppMainLoop()\fR
207 to add xpa fds to the Xt event loop:
208 .Sp
209 .Vb 2
210 \& /* add the xpas to the Xt loop */
211 \& XPAXtAddInput(app, NULL);
212 \&
213 \& /* process events */
214 \& XtAppMainLoop(app);
215 .Ve
216 .IP "\(bu" 4
217 Change \fINewXPA()\fR to \fIXPANew()\fR and call \fIXPAXtAddInput()\fR if the XtAppMainLoop
218 routine already has been entered:
219 .Sp
220 .Vb 4
221 \& xpa = NewXPA(saotng\->xim\->toplevel, prefix, xparoot,
222 \& "FITS data or image filename\en\et\et options: file type",
223 \& XPASendData, new, NULL,
224 \& XPAReceiveData, new, "SE");
225 .Ve
226 .Sp
227 is changed to:
228 .Sp
229 .Vb 6
230 \& sprintf(tbuf, "%s.%s", prefix, xparoot);
231 \& xpa = XPANew("SAOTNG", tbuf,
232 \& "FITS data or image filename\en\et\et options: file type",
233 \& XPASendData, new, NULL,
234 \& XPAReceiveData, new, "SE");
235 \& XPAXtAddInput(XtWidgetToApplicationContext(saotng\->xim\->toplevel), xpa);
236 .Ve
237 .IP "\(bu" 4
238 Change \fIXPAInternalReceiveCommand()\fR to \fIXPACmdInternalReceive()\fR
239 remove first argument in the calling sequence):
240 .Sp
241 .Vb 3
242 \& XPAInternalReceiveCommand(im\->saotng\->xim\->toplevel,
243 \& im\->saotng, im\->saotng\->commands,
244 \& "zoom reset", NULL, 0);
245 .Ve
246 .Sp
247 is changed to:
248 .Sp
249 .Vb 2
250 \& XPACmdInternalReceive(im\->saotng, im\->saotng\->commands,
251 \& "zoom reset", NULL, 0);
252 .Ve
253 .IP "\(bu" 4
254 Change DestroyXPA to XPAFree:
255 .Sp
256 .Vb 1
257 \& DestroyXPA(im\->dataxpa);
258 .Ve
259 .Sp
260 is changed to:
261 .Sp
262 .Vb 1
263 \& XPAFree(im\->dataxpa);
264 .Ve
265 .SH "SEE ALSO"
266 .IX Header "SEE ALSO"
267 See xpa(n) for a list of \s-1XPA\s0 help pages