| blob | b95d45ebc864c45bfbdd75c21f488a6dafbcf350 |
1 ;;; srecode/dictionary.el --- Dictionary code for the semantic recoder.
3 ;; Copyright (C) 2007-2015 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
22 ;;; Commentary:
23 ;;
24 ;; Dictionaries contain lists of names and their associated values.
25 ;; These dictionaries are used to fill in macros from recoder templates.
27 ;;; Code:
29 ;;; CLASSES
49 :documentation
52 :documentation
56 :documentation
57 "The parent dictionary.
58 Symbols not appearing in this dictionary will be checked against the
61 :type string
62 :documentation
63 "A string representing the origin of this dictionary.
65 )
66 "Dictionary of symbols and what they mean.
67 Dictionaries are used to look up named symbols from
71 ()
72 "A compound dictionary value.
73 Values stored in a dictionary must be a STRING,
74 a dictionary for showing sections, or an instance of a subclass
75 of this class.
77 Compound dictionary values derive from this class, and must
78 provide a sequence of method implementations to convert into
79 a string."
85 :documentation
86 "The value of this template variable.
87 Variables in template files are usually a single string
88 which can be inserted into a dictionary directly.
90 Some variables may be more complex and involve dictionary
91 lookups, strings, concatenation, or the like.
93 The format of VALUE is determined by current template
96 :type list
97 :documentation
99 )
100 "A compound dictionary value for template file variables.
101 You can declare a variable in a template like this:
109 "Initialize the compound variable THIS.
110 Makes sure that :value is compiled."
114 ;; Strip out :state
121 ;;(when (not state)
122 ;; (error "Cannot create compound variable outside of sectiondictionary"))
130 )
139 state)
140 comp)))
143 )
147 ;;; DICTIONARY METHODS
148 ;;
151 "Create a dictionary for BUFFER.
152 If BUFFER-OR-PARENT is not specified, assume a buffer, and
153 use the current buffer.
154 If BUFFER-OR-PARENT is another dictionary, then remember the
155 parent within the new dictionary, and assume that BUFFER
156 is the same as belongs to the parent dictionary.
157 The dictionary is initialized with variables setup for that
158 buffer's table.
159 If BUFFER-OR-PARENT is t, then this dictionary should not be
160 associated with a buffer or parent."
162 ;; Handle the parent
168 ;; Parent is a buffer
173 initfrombuff t))
175 ;; Parent is another dictionary
185 ;; No parent
190 ;; Default to unspecified parent
195 initfrombuff t)))
197 ;; Create the new dictionary object.
199 'srecode-dictionary
200 :buffer buffer
201 :parent parent
205 ;; Only set up the default variables if we are being built
206 ;; directly for a particular buffer.
208 ;; Variables from the table we are inserting from.
209 ;; @todo - get a better tree of tables.
212 ;; Each table has multiple template tables.
213 ;; Do DEF first so that MT can override any values.
216 ))
217 dict))))
220 tpl)
221 "Insert into DICT the variables found in table TPL.
222 TPL is an object representing a compiled template file."
224 ;; Tables are sorted with highest priority first, useful for looking
225 ;; up templates, but this means we need to install the variables in
226 ;; reverse order so higher priority variables override lower ones.
240 name value)
241 "In dictionary DICT, set NAME to have VALUE."
242 ;; Validate inputs
246 ;; Add the value.
249 )
253 "In dictionary DICT, add a section dictionary for section macro NAME.
254 Return the new dictionary.
256 You can add several dictionaries to the same section entry.
257 For each dictionary added to a variable, the block of codes in
258 the template will be repeated.
260 If optional argument SHOW-ONLY is non-nil, then don't add a new dictionary
261 if there is already one in place. Also, don't add FIRST/LAST entries.
262 These entries are not needed when we are just showing a section.
264 Each dictionary added will automatically get values for positional macros
265 which will enable SECTIONS to be enabled.
267 * FIRST - The first entry in the table.
268 * NOTFIRST - Not the first entry in the table.
269 * LAST - The last entry in the table
270 * NOTLAST - Not the last entry in the table.
272 Adding a new dictionary will alter these values in previously
273 inserted dictionaries."
274 ;; Validate inputs
282 ;; Setup the FIRST/NOTFIRST and LAST/NOTLAST entries.
287 ;; Not the very first one. Let's clean up CAR.
291 )
294 )
300 ;; Return the new sub-dictionary.
301 new))
304 "In dictionary DICT, indicate that the section NAME should be exposed."
305 ;; Validate inputs
309 ;; Showing a section is just like making a section dictionary, but
310 ;; with no dictionary values to add.
312 nil)
315 "In dictionary DICT, indicate that the section NAME should be hidden."
316 ;; We need to find the has value, and then delete it.
317 ;; Validate inputs
321 ;; Add the value.
324 nil)
328 "Add ENTRIES to DICT.
330 ENTRIES is a list of even length of dictionary entries to
331 add. ENTRIES looks like this:
333 (NAME_1 VALUE_1 NAME_2 VALUE_2 ...)
335 The following rules apply:
336 * NAME_N is a string
337 and for values
338 * If VALUE_N is t, the section NAME_N is shown.
339 * If VALUE_N is a string, an ordinary value is inserted.
340 * If VALUE_N is a dictionary, it is inserted as entry NAME_N.
341 * Otherwise, a compound variable is created for VALUE_N.
343 The optional argument STATE has to non-nil when compound values
344 are inserted. An error is signaled if ENTRIES contains compound
345 values but STATE is nil."
350 ;; Value is t; show a section.
354 ;; Value is a simple string; create an ordinary dictionary
355 ;; entry
359 ;; Value is a dictionary; insert as child dictionary.
363 value t))
365 ;; Value is some other object; create a compound value.
371 dict name
375 dict)
379 "Merge into DICT the dictionary entries from OTHERDICT.
380 Unless the optional argument FORCE is non-nil, values in DICT are
381 not modified, even if there are values of the same names in
382 OTHERDICT."
386 ;; The new values is only merged in if there was no old value
387 ;; or FORCE is non-nil.
388 ;;
389 ;; This protects applications from being whacked, and basically
390 ;; makes these new section dictionary entries act like
391 ;; "defaults" instead of overrides.
395 ;; A list of section dictionaries. We need to merge them in.
401 dict key t t)
402 sub-dict force)))
404 ;; Other values can be set directly.
411 "Return information about DICT's value for NAME.
412 DICT is a dictionary, and NAME is a string that is treated as the
413 name of an entry in the dictionary. If such an entry exists, its
414 value is returned. Otherwise, nil is returned. Normally, the
415 lookup is recursive in the sense that the parent of DICT is
416 searched for NAME if it is not found in DICT. This recursive
417 lookup can be disabled by the optional argument NON-RECURSIVE.
419 This function derives values for some special NAMEs, such as
420 `FIRST' and `LAST'."
422 nil
423 ;; Get the value of this name from the dictionary or its parent
424 ;; unless the lookup should be non-recursive.
429 parent
431 )
434 "For dictionary DICT, return the root dictionary.
435 The root dictionary is usually for a current or active insertion."
439 ans))
441 ;;; COMPOUND VALUE METHODS
442 ;;
443 ;; Compound values must provide at least the toString method
444 ;; for use in converting the compound value into something insertable.
447 function
448 dictionary)
449 "Convert the compound dictionary value CP to a string.
450 If FUNCTION is non-nil, then FUNCTION is somehow applied to an aspect
451 of the compound value. The FUNCTION could be a fraction
452 of some function symbol with a logical prefix excluded.
454 If you subclass `srecode-dictionary-compound-value' then this
455 method could return nil, but if it does that, it must insert
456 the value itself using `princ', or by detecting if the current
457 standard out is a buffer, and using `insert'."
462 "Display information about this compound value."
464 )
467 function
468 dictionary)
469 "Convert the compound dictionary variable value CP into a string.
470 FUNCTION and DICTIONARY are as for the baseclass."
477 "Display information about this compound value."
482 )
484 ))
486 ;;; FIELD EDITING COMPOUND VALUE
487 ;;
488 ;; This is an interface to using field-editing objects
489 ;; instead of asking questions. This provides the basics
490 ;; behind this compound value.
494 :documentation
497 :documentation
499 )
500 "When inserting values with editable field mode, a dictionary value.
501 Compound values allow a field to be stored in the dictionary for when
502 it is referenced a second time. This compound value can then be
506 function
507 dictionary)
508 "Convert this field into an insertable string."
510 ;; If we are not in a buffer, then this is not supported.
517 ;; No function. Perform a plain field insertion.
518 ;; We know we are in a buffer, so we can perform the insertion.
525 ;; No default value.
527 ;; A compound value as the default? Recurse.
530 ;; A string that is empty? Use the name.
533 ;; Insert strings
535 ;; Some other issue
539 ;; Create a field from the inserter.
541 :start start
545 )
546 ))
547 ;; Returning nil is a signal that we have done the insertion ourselves.
548 nil)
550 \f
551 ;;; Higher level dictionary functions
552 ;;
554 "Create a dictionary with entries according to TAGS.
556 TAGS should be in the format produced by the template file
557 grammar. That is
559 TAGS = (ENTRY_1 ENTRY_2 ...)
561 where
563 ENTRY_N = (NAME ENTRY_N_1 ENTRY_N_2 ...) | TAG
565 where TAG is a semantic tag of class 'variable. The (NAME ... )
566 form creates a child dictionary which is stored under the name
567 NAME. The TAG form creates a value entry or section dictionary
568 entry whose name is the name of the tag.
570 STATE is the current compiler state."
576 ;; Entry is a tag
585 value))))
587 ;; Entry is a nested dictionary
593 entries state))))))
594 tags))))
596 dict entries state)
597 dict)
598 )
600 ;;; DUMP DICTIONARY
601 ;;
602 ;; Make a dictionary, and dump it's contents.
605 "Run data-debug on this mode's dictionary."
616 )
623 "Dump a typical fabricated dictionary."
627 ;; This load allows the dictionary access to inherited
628 ;; and stacked dictionary entries.
631 )
634 ;; Now make the dictionary.
641 ))))
644 "Dump a dictionary."
662 ))
664 )
668 )
671 ;(princ "\n")
672 ))
674 )
676 )
680 ;;; srecode/dictionary.el ends here