cgit.sxemacs.org Git - packages/blob - xemacs-packages/ede/ede-sourcecode.texi

   1 @c -*-texinfo-*-
   2 @c
   3 @c $Id: ede-sourcecode.texi,v 1.1 2007-11-26 15:22:11 michaels Exp $
   4 @c
   5
   6 @c The next line is for the back-search to see what node this one
   7 @c resides in.
   8
   9 @c @node Sourcecode,
  10 @c @chapter Source Code Types
  11
  12 @c This command is a convenience to help rebuild this file.  Use C-x C-e
  13 @c on the expression below to rebuild the entire index (but only
  14 @c after loading in all relevant source files.)
  15
  16 @c (eieiodoc-class ede-sourcecode "sc")
  17 @menu
  18 * ede-sourcecode ::
  19 @end menu
  20
  21
  22 @node ede-sourcecode,  ,  , Sourcecode
  23 @comment  node-name,  next,  previous,  up
  24 @section ede-sourcecode
  25 @scindex ede-sourcecode
  26
  27 @table @asis
  28 @item Inheritance Tree:
  29 @table @code
  30 @item eieio-instance-inheritor
  31 @table @code
  32 @item ede-sourcecode
  33 No children
  34 @end table
  35
  36 @end table
  37 @end table
  38
  39   Create a new object with name NAME of class type ede-sourcecode
  40
  41 @table @asis
  42 @item Slots:
  43
  44 @table @code
  45 @item :parent-instance
  46 Type: @code{eieio-instance-inheritor}
  47
  48 The parent of this instance.
  49 If a slot of this class is reference, and is unbound, then  the parent
  50 is checked for a value.
  51 @refill
  52
  53 @item :name
  54 Type: @code{string}
  55
  56 The name of this type of source code.
  57 Such as "C" or "Emacs Lisp"
  58 @refill
  59
  60 @item :sourcepattern
  61 Type: @code{string} @*
  62 Default Value: @code{".*"}
  63
  64 Emacs regex matching sourcecode this target accepts.
  65 @refill
  66
  67 @item :auxsourcepattern
  68 Type: @code{(or null string)} @*
  69 Default Value: @code{nil}
  70
  71 Emacs regex matching auxiliary source code this target accepts.
  72 Aux source are source code files needed for compilation, which are not comiled
  73 themselves.
  74 @refill
  75
  76 @item :enable-subdirectories
  77 Type: @code{boolean} @*
  78 Default Value: @code{nil}
  79
  80 Non @code{nil} if this sourcecode type uses subdirectores.
  81 If sourcecode always lives near the target creating it, this should be nil.
  82 If sourcecode can, or typically lives in a subdirectory of the owning
  83 target, set this to t.
  84 @refill
  85
  86 @item :garbagepattern
  87 Type: @code{list} @*
  88 Default Value: @code{nil}
  89
  90 Shell file regex matching files considered as garbage.
  91 This is a list of items added to an @code{rm} command when executing a @code{clean}
  92 type directive.
  93 @refill
  94
  95 @end table
  96
  97 @end table
  98 @subsection Specialized Methods
  99
 100 @deffn Method initialize-instance :AFTER this &rest fields
 101 Make sure that all ede compiler objects are cached in
 102 @code{ede-compiler-list}.
 103 @end deffn
 104
 105 @deffn Method ede-want-any-files-p :PRIMARY this filenames
 106 Return non-@code{nil} if @var{THIS} will accept any files in @var{FILENAMES}.
 107 @end deffn
 108
 109 @deffn Method ede-want-any-source-files-p :PRIMARY this filenames
 110 Return non-@code{nil} if @var{THIS} will accept any source files in @var{FILENAMES}.
 111 @end deffn
 112
 113 @deffn Method ede-want-any-auxiliary-files-p :PRIMARY this filenames
 114 Return non-@code{nil} if @var{THIS} will accept any aux files in @var{FILENAMES}.
 115 @end deffn
 116
 117 @deffn Method ede-buffer-header-file :PRIMARY this filename
 118 Return a list of file names of header files for @var{THIS} with @var{FILENAME}.
 119 Used to guess header files, but uses the auxsource regular expression.
 120 @end deffn
 121
 122 @deffn Method ede-want-file-p :PRIMARY this filename
 123 Return non-@code{nil} if sourcecode definition @var{THIS} will take @var{FILENAME}.
 124 @end deffn
 125
 126 @deffn Method ede-want-file-source-p :PRIMARY this filename
 127 Return non-@code{nil} if @var{THIS} will take @var{FILENAME} as an auxiliary .
 128 @end deffn
 129
 130 @deffn Method ede-want-file-auxiliary-p :PRIMARY this filename
 131 Return non-@code{nil} if @var{THIS} will take @var{FILENAME} as an auxiliary .
 132 @end deffn
 133
 134