2
# mk-src.in -- Input file for the Perl program to automatically
2
# mk-src.in -- Input file for the Perl program to automatically
3
3
# generate interface code.
5
5
# This file is part of The New Aspell
6
# Copyright (C) 2001 by Kevin Atkinson under the GNU LGPL
6
# Copyright (C) 2001-2005 by Kevin Atkinson under the GNU LGPL
7
7
# license version 2.0 or 2.1. You should have received a copy of the
8
8
# LGPL license along with this library if you did not you can find it
9
9
# at http://www.gnu.org/.
44
44
methods: destructible
51
51
# method: ref count
52
# desc => returns a pointer to an int which may be used
53
# for refrence counting. It will default to 0.
52
# desc => Returns a pointer to an int which may be used
53
# for reference counting. It will default to 0.
54
54
# This integer is not used by the actual library
55
55
# but may be used my some of the front ends.
68
# desc => To objects of the same pointer type may be
69
# assigned to each other only if there type ids
68
# desc => Two objects of the same pointer type may be
69
# assigned to each other only if their type ids
71
71
# cxx impl => return type_id_.num
79
79
# desc => Returns 0 if this object can not be copied,
80
# 1 if it may be copies, 2 if it should be
81
# copyied. Used by some of the front end to
82
# detrime if a deep or shallow copy should be
80
# 1 if it may be copied, 2 if it should be
81
# copied. Used by some of the front ends to
82
# determine if a deep or shallow copy should be
84
84
# cxx impl => return copyable_
201
201
desc => The Key Info object is used for holding information
205
desc => the name of the key
205
desc => The name of the key.
206
206
key info type: type
207
desc => The key type.
209
desc => the default value of the key
209
desc => The default value of the key.
211
desc => a brief description of the key or null if internal value
211
desc => A brief description of the key or NULL if internal value.
231
231
can have error methods
233
233
method: set extra
234
desc => sets extra keys which this config class should accept
235
begin and end are expected to point to the begging
236
and end of an array of Aspell Key Info
234
desc => Sets extra keys which this config class should
235
accept. begin and end are expected to point to
236
the beginning and ending of an array of Aspell
239
240
const key info: begin
244
desc => returns the KeyInfo object for the
245
corresponding key or returns null and sets
245
desc => Returns the KeyInfo object for the
246
corresponding key or returns NULL and sets
246
247
error_num to PERROR_UNKNOWN_KEY if the key is
247
248
not valid. The pointer returned is valid for
248
249
the lifetime of the object.
253
254
method: possible elements
254
desc => returns a newly allocated enumeration of all the
255
possible objects this config class uses
255
desc => Returns a newly allocated enumeration of all
256
the possible objects this config class uses.
257
258
key info enumeration
258
259
int: include extra
260
261
method: get default
262
desc => returns the default value for given key which
263
way involve substating variables, thus it is
264
not the same as keyinfo(key)->def returns null
263
desc => Returns the default value for given key which
264
may involve substituting variables, thus it is
265
not the same as keyinfo(key)->def returns NULL
265
266
and sets error_num to PERROR_UNKNOWN_KEY if
266
267
the key is not valid. Uses the temporary
273
desc => returns a newly alloacted enumeration of all the
274
key/value pairs. This DOES not include ones
275
which are set to their default values
274
desc => Returns a newly allocated enumeration of all
275
the key/value pairs. This DOES not include ones
276
which are set to their default values.
277
278
string pair enumeration
281
desc => inserts an item, if the item already exists it
282
will be replaced. returns true if it succesed
283
or false on error. If the key in not valid it
282
desc => Inserts an item, if the item already exists it
283
will be replaced. Returns TRUE if it succeeded
284
or FALSE on error. If the key in not valid it
284
285
sets error_num to PERROR_UNKNOWN_KEY, if the
285
value is not valid it will sets error_num to
286
value is not valid it will set error_num to
286
287
PERROR_BAD_VALUE, if the value can not be
287
288
changed it sets error_num to
288
289
PERROR_CANT_CHANGE_VALUE, and if the value is
289
a list and you are trying to set it directory
290
a list and you are trying to set its directory,
290
291
it sets error_num to PERROR_LIST_SET
298
desc => remove a key and returns true if it exists
299
otherise return false. This effictly sets the
300
key to its default value. Calling replace with
301
a value of "<default>" will also call
302
remove. If the key does not exists sets
303
error_num to 0 or PERROR_NOT, if the key in
304
not valid sets error_num to
299
desc => Remove a key and returns TRUE if it exists
300
otherwise return FALSE. This effectively sets
301
the key to its default value. Calling replace
302
with a value of "<default>" will also call
303
remove. If the key does not exist then it sets
304
error_num to 0 or PERROR_NOT, if the key is
305
not valid then it sets error_num to
305
306
PERROR_UNKNOWN_KEY, if the value can not be
306
changed sets error_num to
307
changed then it sets error_num to
307
308
PERROR_CANT_CHANGE_VALUE
332
333
method: retrieve bool
334
desc => return -1 on error, 0 if false, 1 if true
335
desc => Return -1 on error, 0 if false, 1 if true.
339
340
method: retrieve int
341
desc => return -1 on error
342
desc => Return -1 on error.
447
448
mesg => The key "%key" does not take any parameters when prefixed by a "reset-".
449
mesg => The key "%key" does not take any parameters when prefixed by a "enable-".
450
mesg => The key "%key" does not take any parameters when prefixed by an "enable-".
451
452
mesg => The key "%key" does not take any parameters when prefixed by a "dont-" or "disable-".
582
583
mesg => "%mode": no start for magic search given for magic "%magic".
584
585
mesg => "%mode": no range for magic search given for magic "%magic".
586
587
mesg => "%mode": no magic expression available for magic "%magic".
588
589
mesg => "%mode": Magic "%magic": bad regular expression after location specifier; regexp reports: "%regerr".
602
603
c impl headers => error
604
# FIME make a "methods" of the next two contractors
605
# which will probaly involve modifying mk-src.pl
605
# FIXME: make a "methods" of the next two contractors
606
# which will probably involve modifying mk-src.pl
607
608
constructor: new aspell speller
636
desc => returns 0 if it is not in the dictionary,
637
desc => Returns 0 if it is not in the dictionary,
637
638
1 if it is, or -1 on error.
640
641
encoded string: word
642
643
method: add to personal
646
desc => Add this word to your own personal word list.
647
649
encoded string: word
656
659
method: personal word list
662
desc => This is your own personal word list file plus
663
any extra words added during this session to
664
your own personal word list.
662
668
method: session word list
671
desc => This is a list of words added to this session
672
that are not in the main word list or in your
673
own personal list but are considered valid for
674
this spelling session.
668
678
method: main word list
681
desc => This is the main list of words used during this
674
686
method: save all word lists
689
desc => Return null on error.
690
the word list returned by suggest is only valid until the next
701
desc => Return NULL on error.
702
The word list returned by suggest is only
703
valid until the next call to suggest.
694
706
encoded string: word
696
708
method: store replacement
790
802
desc => Creates a new document checker.
791
The speller class is expect to last until this
793
If config is given it will be used to overwide
803
The speller class is expected to last until
804
this class is destroyed.
805
If config is given it will be used to override
794
806
any relevent options set by this speller class.
795
807
The config class is not once this function is done.
796
If filter is given then it will take ownership of
808
If filter is given then it will take ownership of
797
809
the filter class and use it to do the filtering.
798
810
You are expected to free the checker when done.
810
desc => reset the internal state of the filter.
811
should be called whenever a new document is being filtered
822
desc => Reset the internal state of the filter.
823
Should be called whenever a new document is
817
desc => process a string
818
The string passed in should only be split on white space
819
characters. Furthermore, between calles to reset, each string
820
should be passed in exactly once and in the order they appeared
821
in the document. Passing in stings out of order, skipping
822
strings or passing them in more than once may lead to undefined
830
desc => Process a string.
831
The string passed in should only be split on
832
white space characters. Furthermore, between
833
calls to reset, each string should be passed
834
in exactly once and in the order they appeared
835
in the document. Passing in strings out of
836
order, skipping strings or passing them in
837
more than once may lead to undefined results.
829
843
method: next misspelling
831
desc => returns the next misspelled word in the processed string
832
if there are no more misspelled word than token.word
833
will be null and token.size will be 0
845
desc => Returns the next misspelled word in the
846
processed string. If there are no more
847
misspelled words, then token.word will be
848
NULL and token.size will be 0
839
desc => returns the underlying filter class
854
desc => Returns the underlying filter class.
911
926
struct: dict info
914
desc => name to identify the dictionary by
929
desc => The Name to identify this dictionary by.
931
desc => The language code to identify this dictionary.
932
A two letter UPPER-CASE ISO 639 language code
933
and an optional two letter ISO 3166 country
934
code after a dash or underscore.
936
desc => Any extra information to distinguish this
937
variety of dictionary from other dictionaries
938
which may have the same language and size.
941
desc => A two char digit code describing the size of
942
the dictionary: 10=tiny, 20=really small,
943
30=small, 40=med-small, 50=med, 60=med-large,
944
70=large, 80=huge, 90=insane. Please check
945
the README in aspell-lang-200?????.tar.bz2 or
946
see SCOWL (http://wordlist.sourceforge.net)
947
for an example of how these sizes are used.
919
948
module info: module
921
950
class: module info list
971
1000
copyable methods
973
1002
list methods: string pair
976
desc => Insert a new element.
977
Will NOT overright an existing entry.
978
Returns false if the element already exists.
1005
desc => Insert a new element.
1006
Will NOT overwrite an existing entry.
1007
Returns FALSE if the element already exists.
985
desc => Insert a new element.
986
Will overright an existing entry.
1014
desc => Insert a new element.
1015
Will overwrite an existing entry.
1016
Always returns TRUE.
995
desc => Looks up an element.
996
Returns null if the element did not exist.
997
Returns an empty string if the element exists but has a null value.
998
Otherwises returns the value
1024
desc => Looks up an element and returns the value.
1025
Returns NULL if the element does not exist.
1026
Returns an empty string if the element exists
1027
but has a NULL value.
1026
1055
func: reset cache
1027
desc => Reset the global cache(s) so that cache queries will create a new
1028
object. If exiting objects are still in use they are not deleted.
1029
If which is NULL than ALL caches will be reset. Current caches are
1030
"encode", "decode", "dictionary", "language", and "keyboard".
1056
desc => Reset the global cache(s) so that cache queries will
1057
create a new object. If existing objects are still in
1058
use they are not deleted. If which is NULL then all
1059
caches will be reset. Current caches are "encode",
1060
"decode", "dictionary", "language", and "keyboard".
added
removed
auto/mk-src.in
