ede / ede-projects.texi

  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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
@c -*-texinfo-*-
@c
@c $Id$
@c

@c The next line is for the back-search to see what node this one
@c resides in.

@c @node Project,
@c @chapter Project Listing

@c This command is a convenience to help rebuild this file.  Use C-x C-e
@c on the expression below to rebuild the entire index (but only
@c after loading in all relevant source files.)

@c (eieiodoc-class ede-project-placeholder "pj")
@menu
* ede-project-placeholder ::
*  ede-project ::
*   ede-proj-project ::
*   project-am-makefile ::
@end menu


@node ede-project-placeholder, ede-project,  , Project
@comment  node-name,  next,  previous,  up
@section ede-project-placeholder
@pjindex ede-project-placeholder

@table @asis
@item Inheritance Tree:
@table @code
@item eieio-speedbar
@table @code
@item eieio-speedbar-directory-button
@table @code
@item ede-project-placeholder
@table @asis
@item Children:
@w{@xref{ede-project}.} 
@end table

@end table

@end table

@end table
@end table

  Create a new object with name NAME of class type ede-project-placeholder

@table @asis
@item Slots:

@table @code
@item :name
Type: @code{string} @*
Default Value: @code{"Untitled"}

The name used when generating distribution files.
@refill

@item :version
Type: @code{string} @*
Default Value: @code{"1.0"}

The version number used when distributing files.
@refill

@item :file
Type: @code{string} @*
Default Value: @code{unbound}

File name where this project is stored.
@refill

@end table

@end table
@subsection Specialized Methods

@deffn Method ede-project-force-load :PRIMARY this 
Make sure the placeholder @var{THIS} is replaced with the real thing.
Return the new object created in its place.
@end deffn

@deffn Method project-interactive-select-target :PRIMARY this prompt 
Make sure placeholder @var{THIS} is replaced with the real thing, and pass through.
@end deffn

@deffn Method project-add-file :PRIMARY this file 
Make sure placeholder @var{THIS} is replaced with the real thing, and pass through.
@end deffn


@node ede-project, ede-proj-project, ede-project-placeholder, Project
@comment  node-name,  next,  previous,  up
@section ede-project
@pjindex ede-project

@table @asis
@item Inheritance Tree:
@table @code
@item eieio-speedbar
@table @code
@item eieio-speedbar-directory-button
@table @code
@item @w{@xref{ede-project-placeholder}.}
@table @code
@item ede-project
@table @asis
@item Children:
@w{@xref{ede-proj-project},} @w{@xref{project-am-makefile}.} 
@end table

@end table

@end table

@end table

@end table
@end table

  Create a new object with name NAME of class type ede-project

@table @asis
@item Slots:

@table @code
@item :targets
Type: @code{list} @*
Default Value: @code{unbound}

List of top level targets in this project.
@refill

@item :configurations
Type: @code{list} @*
Default Value: @code{("debug" "release")}

List of available configuration types.
Individual target/project types can form associations between a configuration,
and target specific elements such as build variables.
@refill

@item :configuration-default @*
Default Value: @code{"debug"}

The default configuration.
@refill

@item :local-variables @*
Default Value: @code{nil}

Project local variables
@refill

@end table

@end table
@subsection Specialized Methods

@deffn Method eieio-speedbar-description :PRIMARY obj 
Provide a speedbar description for @var{OBJ}.
@end deffn

@deffn Method ede-map-any-target-p :PRIMARY this proc 
For project @var{THIS}, map @var{PROC} to all targets and return if any non-nil.
Return the first non-@code{nil} value returned by @var{PROC}.
@end deffn

@deffn Method project-rescan :PRIMARY this 
Rescan the EDE proj project @var{THIS}.
@end deffn

@deffn Method ede-map-subprojects :PRIMARY this proc 
For object @var{THIS}, execute @var{PROC} on all subprojects.
@end deffn

@deffn Method ede-convert-path :PRIMARY this path 
Convert path in a standard way for a given project.
Default to making it project relative.
Argument @var{THIS} is the project to convert @var{PATH} to.
@end deffn

@deffn Method ede-name :PRIMARY this 
Return a short-name for @var{THIS} project file.
Do this by extracting the lowest directory name.
@end deffn

@deffn Method eieio-speedbar-derive-line-path :PRIMARY obj &optional depth 
Return the path to @var{OBJ}.
Optional @var{DEPTH} is the depth we start at.
@end deffn

@deffn Method ede-buffer-header-file :PRIMARY this buffer 
Return @code{nil}, projects don't have header files.
@end deffn

@deffn Method ede-buffer-documentation-files :PRIMARY this buffer 
Return all documentation in project @var{THIS} based on @var{BUFFER}.
@end deffn

@deffn Method ede-map-targets :PRIMARY this proc 
For object @var{THIS}, execute @var{PROC} on all targets.
@end deffn

@deffn Method ede-buffer-mine :PRIMARY this buffer 
Return non-@code{nil} if object @var{THIS} lays claim to the file in @var{BUFFER}.
@end deffn

@deffn Method ede-object-keybindings :PRIMARY this 
Retrieves the slot @code{keybindings} from an object of class @code{ede-project}
@end deffn

@deffn Method ede-description :PRIMARY this 
Return a description suitible for the minibuffer about @var{THIS}.
@end deffn

@deffn Method eieio-speedbar-object-children :PRIMARY this 
Return the list of speedbar display children for @var{THIS}.
@end deffn

@deffn Method project-make-dist :PRIMARY this 
Build a distribution for the project based on @var{THIS} target.
@end deffn

@deffn Method project-new-target-custom :PRIMARY proj 
Create a new target.  It is up to the project @var{PROJ} to get the name.
@end deffn

@deffn Method ede-expand-filename :PRIMARY this filename &optional force 
Return a fully qualified file name based on project @var{THIS}.
@var{FILENAME} should be just a filename which occurs in a directory controlled
by this project.
Optional argument @var{FORCE} forces the default filename to be provided even if it
doesn't exist.
@end deffn

@deffn Method ede-menu-items-build :PRIMARY obj &optional current 
Return a list of menu items for building project @var{OBJ}.
If optional argument @var{CURRENT} is non-@code{nil}, return sub-menu code.
@end deffn

@deffn Method project-new-target :PRIMARY proj 
Create a new target.  It is up to the project @var{PROJ} to get the name.
@end deffn

@deffn Method project-compile-project :PRIMARY obj &optional command 
Compile the entire current project @var{OBJ}.
Argument @var{COMMAND} is the command to use when compiling.
@end deffn

@deffn Method eieio-speedbar-object-buttonname :PRIMARY object 
Return a string to use as a speedbar button for @var{OBJECT}.
@end deffn

@deffn Method ede-map-project-buffers :PRIMARY this proc 
For @var{THIS}, execute @var{PROC} on all buffers belonging to @var{THIS}.
@end deffn

@deffn Method eieio-done-customizing :PRIMARY proj 
Call this when a user finishes customizing @var{PROJ}.
@end deffn

@deffn Method ede-documentation :PRIMARY this 
Return a list of files that provides documentation.
Documentation is not for object @var{THIS}, but is provided by @var{THIS} for other
files in the project.
@end deffn

@deffn Method project-interactive-select-target :PRIMARY this prompt 
Interactivly query for a target that exists in project @var{THIS}.
Argument @var{PROMPT} is the prompt to use when querying the user for a target.
@end deffn

@deffn Method ede-target-in-project-p :PRIMARY proj target 
Is @var{PROJ} the parent of @var{TARGET}?
If @var{TARGET} belongs to a subproject, return that project file.
@end deffn

@deffn Method ede-find-target :PRIMARY proj buffer 
Fetch the target in @var{PROJ} belonging to @var{BUFFER} or nil.
@end deffn

@deffn Method ede-add-subproject :PRIMARY proj-a proj-b 
Add into @var{PROJ-A}, the subproject @var{PROJ-B}.
@end deffn

@deffn Method ede-commit-project :PRIMARY proj 
Commit any change to @var{PROJ} to its file.
@end deffn

@deffn Method ede-object-menu :PRIMARY this 
Retrieves the slot @code{menu} from an object of class @code{ede-project}
@end deffn

@deffn Method ede-commit-local-variables :PRIMARY proj 
Commit change to local variables in @var{PROJ}.
@end deffn


@node ede-proj-project, project-am-makefile, ede-project, Project
@comment  node-name,  next,  previous,  up
@section ede-proj-project
@pjindex ede-proj-project

@table @asis
@item Inheritance Tree:
@table @code
@item eieio-speedbar
@table @code
@item eieio-speedbar-directory-button
@table @code
@item @w{@xref{ede-project-placeholder}.}
@table @code
@item @w{@xref{ede-project}.}
@table @code
@item ede-proj-project
No children
@end table

@end table

@end table

@end table

@end table
@end table

  Create a new object with name NAME of class type ede-proj-project

@table @asis
@item Slots:

@table @code
@item :makefile-type
Type: @code{symbol} @*
Default Value: @code{Makefile}

The type of Makefile to generate.
Can be one of @code{'Makefile}, 'Makefile.in, or 'Makefile.am.
If this value is NOT @code{'Makefile}, then that overrides the @code{:makefile} slot
in targets.
@refill

@item :variables
Type: @code{list} @*
Default Value: @code{nil}

Variables to set in this Makefile.
@refill

@item :configuration-variables
Type: @code{list} @*
Default Value: @code{("debug" (("DEBUG" . "1")))}

Makefile variables to use in different configurations.
These variables are used in the makefile when a configuration becomes active.
@refill

@item :inference-rules @*
Default Value: @code{nil}

Inference rules to add to the makefile.
@refill

@item :automatic-dependencies
Type: @code{boolean} @*
Default Value: @code{t}

Non-@code{nil} to do implement automatic dependencies in the Makefile.
@refill

@end table

@end table
@subsection Specialized Methods

@deffn Method project-rescan :PRIMARY this 
Rescan the EDE proj project @var{THIS}.
@end deffn

@deffn Method ede-proj-makefile-create :PRIMARY this mfilename 
Create a Makefile for all Makefile targets in @var{THIS}.
@var{MFILENAME} is the makefile to generate.
@end deffn

@deffn Method ede-proj-makefile-insert-rules :PRIMARY this 
Insert rules needed by @var{THIS} target.
@end deffn

@deffn Method ede-proj-makefile-tags :PRIMARY this targets 
Insert into the current location rules to make recursive TAGS files.
Argument @var{THIS} is the project to create tags for.
Argument @var{TARGETS} are the targets we should depend on for TAGS.
@end deffn

@deffn Method project-update-version :PRIMARY this 
The @code{:version} of project @var{THIS} has changed.
@end deffn

@deffn Method ede-buffer-mine :PRIMARY this buffer 
Return @code{t} if object @var{THIS} lays claim to the file in @var{BUFFER}.
@end deffn

@deffn Method ede-proj-makefile-insert-variables :PRIMARY this 
Insert variables needed by target @var{THIS}.
@end deffn

@deffn Method project-make-dist :PRIMARY this 
Build a distribution for the project based on @var{THIS} target.
@end deffn

@deffn Method ede-proj-makefile-insert-dist-rules :PRIMARY this 
Insert distribution rules for @var{THIS} in a Makefile, such as CLEAN and DIST.
@end deffn

@deffn Method project-new-target-custom :PRIMARY this 
Create a new target in @var{THIS} for custom.
@end deffn

@deffn Method ede-proj-makefile-create-maybe :PRIMARY this mfilename 
Create a Makefile for all Makefile targets in @var{THIS} if needed.
@var{MFILENAME} is the makefile to generate.
@end deffn

@deffn Method ede-proj-configure-test-required-file :PRIMARY this file 
For project @var{THIS}, test that the file @var{FILE} exists, or create it.
@end deffn

@deffn Method ede-proj-setup-buildenvironment :PRIMARY this &optional force 
Setup the build environment for project @var{THIS}.
Handles the Makefile, or a Makefile.am configure.in combination.
Optional argument @var{FORCE} will force items to be regenerated.
@end deffn

@deffn Method ede-proj-makefile-garbage-patterns :PRIMARY this 
Return a list of patterns that are considred garbage to @var{THIS}.
These are removed with make clean.
@end deffn

@deffn Method ede-proj-configure-synchronize :PRIMARY this 
Synchronize what we know about project @var{THIS} into configure.in.
@end deffn

@deffn Method project-new-target :PRIMARY this 
Create a new target in @var{THIS} based on the current buffer.
@end deffn

@deffn Method project-compile-project :PRIMARY proj &optional command 
Compile the entire current project @var{PROJ}.
Argument @var{COMMAND} is the command to use when compiling.
@end deffn

@deffn Method ede-proj-makefile-configuration-variables :PRIMARY this configuration 
Return a list of configuration variables from @var{THIS}.
Use @var{CONFIGURATION} as the current configuration to query.
@end deffn

@deffn Method eieio-done-customizing :PRIMARY proj 
Call this when a user finishes customizing this object.
Argument @var{PROJ} is the project to save.
@end deffn

@deffn Method ede-proj-configure-recreate :PRIMARY this 
Delete project @var{THIS}es configure script and start over.
@end deffn

@deffn Method ede-proj-makefile-insert-user-rules :PRIMARY this 
Insert user specified rules needed by @var{THIS} target.
This is different from @dfn{ede-proj-makefile-insert-rules} in that this
function won't create the building rules which are auto created with
automake.
@end deffn

@deffn Method ede-proj-dist-makefile :PRIMARY this 
Return the name of the Makefile with the DIST target in it for @var{THIS}.
@end deffn

@deffn Method ede-proj-configure-file :PRIMARY this 
The configure.in script used by project @var{THIS}.
@end deffn

@deffn Method ede-commit-project :PRIMARY proj 
Commit any change to @var{PROJ} to its file.
@end deffn

@deffn Method ede-commit-local-variables :PRIMARY proj 
Commit change to local variables in @var{PROJ}.
@end deffn


@node project-am-makefile,  , ede-proj-project, Project
@comment  node-name,  next,  previous,  up
@section project-am-makefile
@pjindex project-am-makefile

@table @asis
@item Inheritance Tree:
@table @code
@item eieio-speedbar
@table @code
@item eieio-speedbar-directory-button
@table @code
@item @w{@xref{ede-project-placeholder}.}
@table @code
@item @w{@xref{ede-project}.}
@table @code
@item project-am-makefile
No children
@end table

@end table

@end table

@end table

@end table
@end table

  Create a new object with name NAME of class type project-am-makefile

@table @asis
@item Slots:

@table @code
@item :targets
Type: @code{list} @*
Default Value: @code{nil}

@xref{ede-project}.
@end table

@end table
@subsection Specialized Methods

@deffn Method project-rescan :PRIMARY this 
Rescan the makefile for all targets and sub targets.
@end deffn

@deffn Method project-am-subtree :PRIMARY ampf subpath 
Return the sub project in @var{AMPF} specified by @var{SUBPATH}.
@end deffn

@deffn Method project-targets-for-file :PRIMARY proj 
Return a list of targets the project @var{PROJ}.
@end deffn

@deffn Method ede-buffer-mine :PRIMARY this buffer 
Return @code{t} if object @var{THIS} lays claim to the file in @var{BUFFER}.
@end deffn

@deffn Method project-new-target :PRIMARY proj 
Create a new target named NAME.
Argument TYPE is the type of target to insert.  This is a string
matching something in @code{project-am-type-alist} or type class symbol.
Despite the fact that this is a method, it depends on the current
buffer being in order to provide a smart default target type.
@end deffn

@deffn Method project-compile-project :PRIMARY obj &optional command 
Compile the entire current project.
Argument @var{COMMAND} is the command to use when compiling.
@end deffn

@deffn Method ede-find-target :PRIMARY amf buffer 
Fetch the target belonging to @var{BUFFER}.
@end deffn
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.