README.md 20.3 KB
Newer Older
1
## Pd-L2Ork
pokergaming's avatar
pokergaming committed
2

Jonathan Wilkes's avatar
Jonathan Wilkes committed
3
maintainer: Ivica Ico Bukvic <ico@vt.edu>
pokergaming's avatar
pokergaming committed
4

Jonathan Wilkes's avatar
Jonathan Wilkes committed
5
6
maintainer: Albert Graef <aggraef@gmail.com>

pokergaming's avatar
pokergaming committed
7
8
maintainer: Jonathan Wilkes <jancsika@yahoo.com>

9
10
[Mailing List](http://disis.music.vt.edu/cgi-bin/mailman/listinfo/l2ork-dev)

11
12
13
14
15
* [One Paragraph Overview](#one-paragraph-overview)
* [Flavors of Pure Data](#flavors-of-pure-data)
* [Three Paragraph Overview](#three-paragraph-overview)
* [Goals](#goals)
* [Installation Guide](#installation-guide)
16
17
18
  * [Gnu/Linux](#linux)
  * [OSX](#osx-64-bit-using-homebrew)
  * [Windows](#windows-32-bit-using-msys2)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
19
* [Code of Conduct](#code-of-conduct)
20
* [Contributor Guide](#contributor-guide)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
21
* [Human Interface Guidelines](#human-interface-guidelines)
22
* [Core Pd Notes](#core-pd-notes)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
23
* [GUI Message Spec](#gui-messaging-specification)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
24

pokergaming's avatar
pokergaming committed
25
### One Paragraph Overview
pokergaming's avatar
pokergaming committed
26

Jonathan Wilkes's avatar
Jonathan Wilkes committed
27
Pure Data (aka Pd) is a visual programming language.  That means you can use it to
pokergaming's avatar
pokergaming committed
28
create software graphically by drawing diagrams instead of writing lines of
Jonathan Wilkes's avatar
Jonathan Wilkes committed
29
code.  These diagrams show how data flows through the software, displaying on
pokergaming's avatar
pokergaming committed
30
31
the screen what text-based languages require you to piece together in your mind.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
32
### Flavors of Pure Data
pokergaming's avatar
pokergaming committed
33
34

There are currently three main distributions of Pure Data:
pokergaming's avatar
pokergaming committed
35

36
37
1. Pd-L2Ork.  Version used by Ivica Bukvic for his laptop orchestra.  This
   guide is for Pd-L2Ork.
pokergaming's avatar
pokergaming committed
38
39
40
41
2. Pure Data "Vanilla".  Miller Puckette's personal version which he hosts on
   his website and maintains.  It doesn't include external libraries like
   objects for doing graphics, video, etc.
2. Pure Data Extended.  A monolithic distribution which ships with lots of
Jonathan Wilkes's avatar
Jonathan Wilkes committed
42
   external libraries.  As of August 2015 it hasn't been updated since January 2014.
pokergaming's avatar
pokergaming committed
43
44

### Three Paragraph Overview
pokergaming's avatar
pokergaming committed
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

Pd has been designed with an emphasis on generating sound, video,
2D/3D graphics, and connecting through sensors, input devices, and MIDI as well
as OSC devices.

Pd has a special emphasis on generating audio and/or video in real time, with
low latency.  Much of its design focuses on receiving, manipulating, and
delivering high-quality audio signals.  Specifically, the software addresses
the problem of how to do this efficiently and reliably on general purpose
operating systems like OSX, Windows, Debian, etc.-- i.e., systems designed
mainly for multi-tasking.

Pd can easily work over local and remote networks.  It can be used to integrate
wearable technology, motor systems, lighting rigs, and other equipment. Pd is
also suitable for learning basic multimedia processing and visual programming
methods, as well as for realizing complex systems for large-scale projects.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
62
### Goals
pokergaming's avatar
pokergaming committed
63

64
Pd-L2ork has the following goals:
pokergaming's avatar
pokergaming committed
65

pokergaming's avatar
pokergaming committed
66
67
1. Documentation.  We like documentation.  It's like code, except friendly.
2. Be reliable.  Binary releases must be usable for performances and
pokergaming's avatar
pokergaming committed
68
69
   installations.  The git repo must always be in a workable state that can be
   compiled.  Regressions must be fixed quickly.
pokergaming's avatar
pokergaming committed
70
3. Be discoverable.  Undocumented features are buggy.  Missing help files are
pokergaming's avatar
pokergaming committed
71
   bugs.  Patches for new functionality that lack documentation are spam.
pokergaming's avatar
pokergaming committed
72
4. Be consistent.  Consistent interfaces are themselves a kind of
pokergaming's avatar
pokergaming committed
73
   documentation.  We like documentation, so it follows that we like consistent
74
   interfaces
pokergaming's avatar
pokergaming committed
75

Jonathan Wilkes's avatar
Jonathan Wilkes committed
76
### Installation Guide
77
78

#### Linux
79
Time to build: *40 minutes to 1.5 hours*
80
Hard drive space required: *roughly 2.5 GB*
pokergaming's avatar
pokergaming committed
81
82
83
84
85
86
87
88
89
90
To install using a pre-compiled binary, follow these instructions:
http://l2ork.music.vt.edu/main/?page_id=56

To set up a development environment, first make sure you have the following
package dependencies listed here:
http://l2ork.music.vt.edu/main/?page_id=56

Then follow the steps outlined here:
http://l2ork.music.vt.edu/main/?page_id=56#install-dev

91
92
93
#### OSX 64-bit using Homebrew
Time to build: *50 minutes to 1.5 hours*
Hard drive space required: *roughly 2 GB*
94
95
1. Install [Homebrew](http://brew.sh) *(15 minutes)*
   (asks for password twice-- once for command line tools, once for homebrew)
96
2. Install the dependencies *(10 minutes)*:<code>
97
98
99
100
101
102
103
104
105
106
107
108
109
110
   brew install wget
   brew install autoconf
   brew install automake
   brew install libtool
   brew install fftw
   brew install python
   brew install fluidsynth
   brew install lame
   brew install libvorbis
   brew install speex
   brew install gsl
   brew install libquicktime
   brew install pkg-config
</code>
111
112
3. Clone the Purr-Data repository *(10 minutes)*<code>
git clone https://git.purrdata.net/jwilkes/purr-data.git</code>
113
114
4. Change to the directory<code>
cd purr-data/l2ork_addons</code>
115
116
5. Run the installer *(15 minutes)*<code>
./tar_em_up.sh -X</code>
117
118
119
6. When the installer finishes, type<code>
cd ..</code>
7. There should now be a .dmg file in your current directory
120

121
#### Windows 32-bit Using msys2
122
Time to build: *roughly 1.5 hours-- 30 minutes of this is for Gem alone*
123
Hard drive space required to build: *rougly 2.5 GB*
Jonathan Wilkes's avatar
Jonathan Wilkes committed
124

125
126
127
128
Important note: check the name of your Windows user account. If it has a space
in it-- like "My Home Computer" or "2nd Laptop", then **stop**. You may not
use this guide.  (Actually you can probably just install everything in ~/.. in
that case, but I haven't tested doing it like that. Sorry. Get a better OS...)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
129
130
131
132
133
1. Download and install [msys2](https://msys2.github.io/) *(5 minutes)*  
  There are two installers-- one for 32-bit Windows systems (i386) and one for
  64-bit Windows (x_64). Be sure you know which
  [version](http://windows.microsoft.com/en-us/windows/32-bit-and-64-bit-windows#1TC=windows-7)
  of Windows you are running and download the appropriate installer.  
134
135
136
137
  Note: don't run it after it installs. You'll open it manually in the next
  step.
2. Download and install [inno setup](http://www.jrsoftware.org/isdl.php) *(5 minutes)*
3. Run MinGW-w64 Win32 Shell *(less than a minute)*  
Jonathan Wilkes's avatar
Jonathan Wilkes committed
138
   msys2 adds three Start Menu items for different "flavors" of shell:  
Jonathan Wilkes's avatar
Jonathan Wilkes committed
139
   + MinGW-w64 __Win32__ Shell <- click this one!
Jonathan Wilkes's avatar
Jonathan Wilkes committed
140
   + MinGW-w64 Win64 Shell
Jonathan Wilkes's avatar
Jonathan Wilkes committed
141
   + MSYS Shell
142
4. Install the dependencies *(5-10 minutes)*  
Jonathan Wilkes's avatar
Jonathan Wilkes committed
143
144
   Once the shell opens, we need to install the dependencies for building
   Purr Data. Issue the following command:<code>
145
146
pacman -S autoconf automake git libtool \
          make mingw-w64-i686-dlfcn mingw-w64-i686-fftw \
147
          mingw-w64-i686-fluidsynth \
148
          mingw-w64-i686-ftgl mingw-w64-i686-fribidi \
149
150
          mingw-w64-i686-ladspa-sdk mingw-w64-i686-lame \
          mingw-w64-i686-libsndfile mingw-w64-i686-libvorbis \
151
          mingw-w64-i686-lua mingw-w64-i686-toolchain \
152
          rsync unzip wget</code>
153
5. Download the source code *(3-6 minutes)*
Jonathan Wilkes's avatar
Jonathan Wilkes committed
154
155
   Issue the following command to create a new directory "purr-data" and clone
   the repository to it:<code>
156
git clone https://git.purrdata.net/jwilkes/purr-data.git</code>
157
6. Enter the purr-data/l2ork_addons directory *(less than a minute)*<code>
158
cd purr-data/l2ork_addons</code>
159
7. Finally, build Purr-Data *(45-80 minutes)*<code>
160
./tar_em_up.sh -Z</code>
161
8. Look in purr-data/packages/win32_inno/Output and click the setup file to
162
   start installing Purr Data to your machine.
163

164
165
### Code of Conduct

166
1. No sarcasm, please
167
2. Don't appear to lack empathy
Jonathan Wilkes's avatar
Jonathan Wilkes committed
168
169
170
171
172
173
174
175
3. You can't live here. If you're spending hours a day writing Purr Data
   code or-- worse-- spending hours a day *writing emails about* code that 
   has yet to be written, you're doing it wrong
4. If working on something for the first time, ask to be mentored
5. If no one asked you to mentor them, don't teach
6. It is better to let small things go then to risk taking time away from
   solving bigger problems

Jonathan Wilkes's avatar
Jonathan Wilkes committed
176
177
It is a bad idea to break this Code of Conduct *even if* no one complains
about your behavior.
178

Jonathan Wilkes's avatar
Jonathan Wilkes committed
179
### Contributor Guide
pokergaming's avatar
pokergaming committed
180

pokergaming's avatar
pokergaming committed
181
Contributing is easy:
pokergaming's avatar
pokergaming committed
182

pokergaming's avatar
pokergaming committed
183
184
185
186
187
188
189
190
191
1. Join the development list:
   http://disis.music.vt.edu/cgi-bin/mailman/listinfo/l2ork-dev
2. Tell us what you'd like to work on.  Unfortunately there are _lots_ of
   externals and even core features that are poorly documented.  We can help 
   make sure you aren't duplicating functionality (or that you at least know
   what's already been implemented).
3. Send us your patch and we'll try it out.  If it's well-documented and
   there aren't any bugs we'll add it to the software.
4. If you want to do regular development and have commit access, just request
192
   it, then follow the Pd-L2Ork goals above.
pokergaming's avatar
pokergaming committed
193

pokergaming's avatar
pokergaming committed
194
195
196
Here are some of the current tasks:

* writing small audio/visual Pd games or demos to include in the next release
pokergaming's avatar
pokergaming committed
197
  * skills needed: ability to write Pd programs
pokergaming's avatar
pokergaming committed
198
  * status: I wrote a little sprite-based game that will ship with the next
199
    version of Pd-L2Ork.  In it, the character walks around in an actual
pokergaming's avatar
pokergaming committed
200
201
202
203
204
    Pd diagram shoots at the objects to progress, and to make realtime
    changes to the music.
    What I'd like is to include a new, smallish game with each release
    that has a link in the Pd console.  It can be a little demo or game,
    just something fun that shows off what can be done using Pure Data.
pokergaming's avatar
pokergaming committed
205
* designing/implementing regression test template
pokergaming's avatar
pokergaming committed
206
  * skills needed: knowledge about... regression tests. :)  But also some
pokergaming's avatar
pokergaming committed
207
208
209
210
211
212
213
214
215
216
217
218
219
    expertise in using Pd so that the tests themselves can
    be written in Pure Data.  At the same time, they should
    be able to be run as part of the automated packaging
    process (i.e., in -nogui mode).
  * status: some externals have their own testing environments, but they are
    limited as they require manual intervention to run and read the
    results inside a graphical window.
    Here's an email thread with Katja Vetter's design, which looks to
    be automatable:
    http://markmail.org/message/t7yitfc55anus76i#query:+page:1+mid:chb56ve7kea2qumn+state:results
    And Mathieu Bouchard's "pure unity" (not sure if this is the most
    recent link...):
    http://sourceforge.net/p/pure-data/svn/HEAD/tree/tags/externals/pureunity/pureunity-0.0/
pokergaming's avatar
pokergaming committed
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
### Human Interface Guidelines

#### General Look and Feel

Pd is a multi-window application that consists of three parts:

1. A main window, called the "Pd Window" or "Console Window". This window
   displays informational and error messages for Pd programs.
2. One or more "canvas" windows-- aka "patch" windows, used to display the
   diagrams that make up a Pd program.
3. One or more dialog windows used to configure the various parts of Pd.

All should look simple and uncluttered. Although "canvas" windows cannot
(yet) be traversed and edited using only the keyboard, all three parts of Pd
should be designed so that they can be manipulated using only the keyboard.

### Hooks for new users
It should also be possible to produce sound and interact when a new user runs
program for the very first time. In every release, there should be a link at
the bottom of the Console Window to a short game written in Pd that demonstrates
one or more of the capabilities of the Pd environment. The game should be
designed to be fun outside of its efficacy as a demonstration of Pd.

#### Fonts
Pd ships with "DejaVu Sans Mono", which is used for the text in canvas windows.
Fonts are sized to fit the hard-coded constraints in Pd Vanilla. This way box
sizes will match as closely as possible across distributions and OSes.

These hard-coded sizes are maximum character widths and heights. No font
fits these maximums exactly, so it's currently impossible to tell when looking
at a Pd canvas whether the objects will collide on a system using a different
font (or even a different font-rendering engine).

Dialogs and console button labels may use variable-width fonts. There is not
yet a suggested default to use for these.

The console printout area currently uses "DejaVu Sans Mono". Errors are printed
as a link so that the user can click them to highlight the corresponded canvas
or object that triggered the error.

#### Colors

Nothing set in stone yet.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
265
### Core Pd Notes
pokergaming's avatar
pokergaming committed
266

pokergaming's avatar
pokergaming committed
267
268
The following is adapted from Pd Vanilla's original source notes.  (Found
in pd/src/CHANGELOG.txt for some reason...)
pokergaming's avatar
pokergaming committed
269
270
271
272

Sections 2-3 below are quite old.  Someone needs to check whether they even
hold true for Pd Vanilla any more.

pokergaming's avatar
pokergaming committed
273
274
275
#### Structure definition roadmap.

First, the containment tree of things
pokergaming's avatar
pokergaming committed
276
277
278
279
that can be sent messages ("pure data").  (note that t_object and t_text,
and t_graph and t_canvas, should be unified...)

BEFORE 0.35:
pokergaming's avatar
pokergaming committed
280

pokergaming's avatar
pokergaming committed
281
282
283
284
285
286
287
288
    m_pd.h	    t_pd    	    	    anything with a class
                    t_gobj	    	    "graphic object"
                        t_text  	    text object
    g_canvas.h  
                        t_glist 	    list of graphic objects
    g_canvas.c  	    	t_canvas    Pd "document"

AFTER 0.35:
pokergaming's avatar
pokergaming committed
289

pokergaming's avatar
pokergaming committed
290
291
292
293
294
295
    m_pd.h	    t_pd    	    	    anything with a class
                    t_gobj	    	    "graphic object"
                        t_text  	    patchable object, AKA t_object
    g_canvas.h     	    	t_glist     list of graphic objects, AKA t_canvas

Other structures:
pokergaming's avatar
pokergaming committed
296
297
298
299
300
301
302

    g_canvas.h  t_selection -- linked list of gobjs
                t_editor -- editor state, allocated for visible glists
    m_imp.h     t_methodentry -- method handler
                t_widgetbehavior -- class-dependent editing behavior for gobjs
                t_parentwidgetbehavior -- objects' behavior on parent window
                t_class -- method definitions, instance size, flags, etc.
pokergaming's avatar
pokergaming committed
303

pokergaming's avatar
pokergaming committed
304
#### 1. Coding Style
pokergaming's avatar
pokergaming committed
305

pokergaming's avatar
pokergaming committed
306
1.0  C coding style.  The source should pass most "warnings" of C compilers
pokergaming's avatar
pokergaming committed
307
308
309
310
311
312
(-Wall on linux, for instance; see the makefile.)  Some informalities
are intentional, for instance the loose use of function prototypes (see
below) and uncast conversions from longer to shorter numerical formats.
The code doesn't respect "const" yet.

1.1.  Prefixes in structure elements.  The names of structure elements always
313
have a K&R-style prefix, as in `((t_atom)x)->a_type`, where the `a_` prefix
pokergaming's avatar
pokergaming committed
314
indicates "atom."  This is intended to enhance readability (although the
315
316
317
318
319
320
321
322
323
324
325
326
convention arose from a limitation of early C compilers.)  Common prefixes are:
  * `w_` (word)
  * `a_` (atom)
  * `s_` (symbol)
  * `ob_` (object)
  * `te_` (text object)
  * `g_` (graphical object)
  * `gl_` (glist, a list of graphical objects).

Also, global symbols sometimes get prefixes, as in `s_float` (the symbol whose
string is "float").  Typedefs are prefixed by `t_`.  Most _private_ structures,
i.e., structures whose definitions appear in a ".c" file, are prefixed by `x_`.
pokergaming's avatar
pokergaming committed
327
328

1.2.   Function arguments.  Many functions take as their first
329
330
331
argument a pointer named `x`, which is a pointer to a structure suggested
by the function prefix; e.g., `canvas_dirty(x, n)` where `x` points to a canvas
`(t_canvas *x)`.
pokergaming's avatar
pokergaming committed
332
333
334
335
336
337
338
339
340
341
342
343
344

1.3.  Function Prototypes.  Functions which are used in at least two different
files (besides where they originate) are prototyped in the appropriate include
file. Functions which are provided in one file and used in one other are
prototyped right where they are used.  This is just to keep the size of the
".h" files down for readability's sake.

1.4.  Whacko private terminology.  Some terms are lifted from other historically
relevant programs, notably "ugen" (which is just a tilde object; see d_ugen.c.)

1.5.  Spacing.  Tabs are 8 spaces; indentation is 4 spaces.  Indenting
curly brackets are by themselves on their own lines, as in:

Jonathan Wilkes's avatar
Jonathan Wilkes committed
345
346
347
348
349
350
```c
if (x)
{
    x = 0;
}
```
pokergaming's avatar
pokergaming committed
351
352
353

Lines should fit within 80 spaces.

pokergaming's avatar
pokergaming committed
354
355
356
#### 2. Compatibility with Max

2.0.  Max patch-level compatibility.  "Import" and "Export" functions are
pokergaming's avatar
pokergaming committed
357
358
359
360
361
362
363
provided which aspire to strict compatibility with 0.26 patches (ISPW version),
but which don't get anywhere close to that yet.  Where possible, features
appearing on the Mac will someday also be provided; for instance, the connect
message on the Mac offers segmented patch cords; these will devolve into
straight lines in Pd.  Many, many UI objects in Opcode Max will not appear in
Pd, at least at first.

pokergaming's avatar
pokergaming committed
364
365
366
#### 3. Source-level Compatibility with Max

3.0.  Compatibility with Max 0.26 "externs"-- source-level compatibility. Pd
pokergaming's avatar
pokergaming committed
367
368
369
370
371
372
373
374
375
objects follow the style of 0.26 objects as closely as possible, making
exceptions in cases where the 0.26 model is clearly deficient.  These are:

3.1.  Anything involving the MacIntosh "Handle" data type is changed to use
char * or void * instead.

3.2.  Pd passes true single-precision floating-point arguments to methods;
Max uses double.
Typedefs are provided:
376

pokergaming's avatar
pokergaming committed
377
378
379
380
381
382
383
384
385
386
    t_floatarg, t_intarg for arguments passed by the message system
    t_float, t_int for the "word" union (in atoms, for example.)

3.3.  Badly-named entities got name changes:

    w_long --> w_int (in the "union word" structure)

3.4.  Many library functions are renamed and have different arguments;
I hope to provide an include file to alias them when compiling Max externs.

pokergaming's avatar
pokergaming committed
387
388
389
#### 4. Function name prefixes

4.0.  Function name prefixes.
pokergaming's avatar
pokergaming committed
390
391
Many function names have prefixes which indicate what "package" they belong
to.  The exceptions are:
pokergaming's avatar
pokergaming committed
392

pokergaming's avatar
pokergaming committed
393
394
395
396
397
    typedmess, vmess, getfn, gensym (m_class.c)
    getbytes, freebytes, resizebytes (m_memory.c)
    post, error, bug (s_print.c)
which are all frequently called and which don't fit into simple categories.
Important packages are:
398

pokergaming's avatar
pokergaming committed
399
400
401
402
403
404
405
    (pd-gui:)   pdgui -- everything
    (pd:)	    pd -- functions common to all "pd" objects
                obj -- fuctions common to all "patchable" objects ala Max
                sys -- "system" level functions
                binbuf -- functions manipulating binbufs
                class -- functions manipulating classes
                (other) -- functions common to the named Pd class
pokergaming's avatar
pokergaming committed
406

pokergaming's avatar
pokergaming committed
407
408
409
#### 5. Source file prefixes

5.0. Source file prefixes. 
410

pokergaming's avatar
pokergaming committed
411
PD:
412

Jonathan Wilkes's avatar
Jonathan Wilkes committed
413
414
415
416
417
418
    s    system interface
    m    message system
    g    graphics stuff
    d    DSP objects
    x    control objects
    z    other
pokergaming's avatar
pokergaming committed
419
420

PD-GUI:
421

Jonathan Wilkes's avatar
Jonathan Wilkes committed
422
    gui    GUI front end
423
424
425
426
427
428

#### 6. Javascript style
1. Brackets on the same line as declaration or expression: `if (a) {`
2. Single line comments only: `//`
3. Use double-quotes for strings
4. Use underscores to separate words of function names and variables
Jonathan Wilkes's avatar
Jonathan Wilkes committed
429
430

### GUI Messaging Specification
Jonathan Wilkes's avatar
Jonathan Wilkes committed
431
#### Public GUI interface
Jonathan Wilkes's avatar
Jonathan Wilkes committed
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446

Purpose: a set of functions to communicate with the gui without putting
language-specific strings (like tcl) into the C code.  The new interface is a
step toward separating some (but not all) of the GUI logic out from the C code.
Of course the GUI can still be designed to parse and evaluate incoming messages
as commands.  But the idiosyncracies of the GUI toolkit can be limited to
either the GUI code itself or to a small set of modular wrappers around
sys_vgui.

The public interface consists of the following:

```c
gui_vmess(const char *msg, const char *format, ...);
```

447
where `const char *format` consists of zero or more of the following:
Jonathan Wilkes's avatar
Jonathan Wilkes committed
448

449
450
451
* f - floating point value (`t_float`)
* i - integer (`int`)
* s - c string (`char*	)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
452
* x - hexadecimal integer value, with a precision of at least six digits.
453
      (hex value is preceded by an 'x', like `x123456`)
Jonathan Wilkes's avatar
Jonathan Wilkes committed
454
455
456
457
458

For some of Pd's internals like array visualization, the message length may
vary. For these _special_ cases, the following functions allow the developer
to iteratively build up a message to send to the GUI.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
459
460
```c
gui_start_vmess(const char *msg, const char *format, ...);
Jonathan Wilkes's avatar
Jonathan Wilkes committed
461
462
463
464
465
466
gui_start_array();      // start an array
gui_f(t_float float);   // floating point array element (t_float)
gui_i(int int);         // integer array element (int)
gui_s(const char *str); // c string array element
gui_end_array();        // end an array
gui_end_vmess();        // terminate the message
Jonathan Wilkes's avatar
Jonathan Wilkes committed
467
468
469
470
471
472
473
474
475
476
477
478
```

The above will send a well-formed message to the GUI, where the number of array
elements are limited by the amount of memory available to the GUI. Because of
the complexity of this approach, it may _only_ be used when it is necessary to
send a variable length message to the GUI. (Some of the current code may
violate this rule, but that can be viewed as a bug which needs to get fixed.)

The array element functions gui_f, gui_i, and gui_s may only be used inside an
array.  Arrays may be nested, but this adds complexity and should be avoided if
possible.

Jonathan Wilkes's avatar
Jonathan Wilkes committed
479
#### Private Wrapper for Nw.js Port
Jonathan Wilkes's avatar
Jonathan Wilkes committed
480
481
482
483
484
485
486
487
488
489
490
491
492
493

The public functions above should fit any sensible message format.
Unfortunately, Pd's message format (FUDI) is too simplistic to handle arbitrary
c-strings and arrays, so it cannot be used here. (But if it happens to improve
in the future it should be trivial to make a wrapper for the public interface
above.)

The current wrapper was made with the assumption that there is a Javascript
Engine at the other end of the message. Messages consist of a selector,
followed by whitespace, followed by a comman-delimited list of valid Javascript
primitives (numbers, strings, and arrays). For the arrays, Javascript's array
notation is used. This is a highly idiosyncratic, quick-and-dirty approach.
But the point is that the idiosyncracy exists in a single file of the source
code, and can be easily made more modular (or replaced entirely by something
494
else) without affecting _any_ of the rest of the C code.