Log of autodoc.git/autodoc.xml

1996-10-13

1996-10-13 15:14:01 by Mirar (Pontus Hagland) <pike@sort.mirar.org>

a9858af357381e1f9917d755034145eac92156da (382 lines) (+381/-1) ^{[

Show
| Annotate

]}
Branch: 8.0

speeded tuned_box, bugfixes, updated doc...

Rev: src/modules/image/doc/image.html:1.2
Rev: src/modules/image/font.c:1.5
Rev: src/modules/image/image.c:1.11

860: </doc> </docgroup> + <docgroup homogen-name='add_shared_strings' homogen-type='method'> + <method name='add_shared_strings'/><doc placeholder='true'> + <text> + <tt>add_shared_strings</tt> - add two pike strings + + <tt>#include "stralloc.h" + + + struct pike_string *add_shared_strings(struct pike_string *a, + <dl><group><text>struct pike_string *b); + </text></group></dl> + </tt> + This function builds the string a+b, that is the string a with the + string b appended to it. Note that the string returned will have + an extra reference. + + pike_string</text> + + <group><seealso/><text> + <ref resolved='predef::begin_shared_string' to='begin_shared_string'>begin_shared_string</ref> and <ref to='make_shared_string'>make_shared_string</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='aggregage_list' homogen-type='method'> <method name='aggregage_list'/><doc placeholder='true'> <text>
1173: ({ <dl><group><text><matrix> <r><c> file, </c><c> /* a string with the filename if known, else zero */ </c></r> - <r><c> function, </c><c> /* The function-pointer to the called function */ </c></r> + <r><c> line, </c><c> /* an integer containing the line if known, else zero */ </c></r> - + <r><c> function, </c><c> /* The function-pointer to the called function */ </c></r> </matrix> </text></group></dl>}) 
1189: </doc> </docgroup> + <docgroup homogen-name='begin_shared_string' homogen-type='method'> + <method name='begin_shared_string'/><doc placeholder='true'> + <text> + <tt>begin_shared_string</tt> - allocate space for a shared string + + <tt>#include "stralloc.h" + + + struct pike_string *begin_shared_string(INT32 len); + + </tt> + This function allocates space for a shared string of length 'len'. + You should then MEMCPY 'len' bytes into the s->str. (s being the + returned value) And then call end_shared_string. + + pike_string</text> + + <group><seealso/><text> + <ref resolved='predef::end_shared_string' to='end_shared_string'>end_shared_string</ref> and <ref to='make_shared_string'>make_shared_string</ref> + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='binary_findstring' homogen-type='method'> + <method name='binary_findstring'/><doc placeholder='true'> + <text> + <tt>binary_findstring</tt> - find a string + + <tt>#include "stralloc.h" + + + struct pike_string *binary_findstring(char *str, INT32 length); + + </tt> + This function looks for the 'str' with length 'len' in the + global hash table. It returns the shared string if found, otherwise + zero. It does not increase/decrease the references to the string. + + pike_string</text> + + <group><seealso/><text> + <ref resolved='predef::findstring' to='findstring'>findstring</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='break' homogen-type='method'> <method name='break'/><doc placeholder='true'> <text>
1764: </doc> </docgroup> + <docgroup homogen-name='end_shared_string' homogen-type='method'> + <method name='end_shared_string'/><doc placeholder='true'> + <text> + <tt>end_shared_string</tt> - link a shared string into the hashtable + + <tt>#include "stralloc.h" + + + struct pike_string *end_shared_string(struct pike_string *p); + + </tt> + This function the prepared output from a begin_shared_string and + links the string into the hash table. If an identical string is + already present in the hash table, p is freed and that string is + returned instead. The returned string will have one extra reference + added. + </text> + + <group><example/><text> + <tt>#include "global.h" + #include "stralloc.h" + + + struct pike_string *mkcharstring(int ch) + { + <dl><group><text>struct pike_string *ret; + ret=begin_shared_string(1); + ret->str[0]=ch; + return end_shared_string(ret); + </text></group></dl>} + + </tt> + pike_string</text></group> + + <group><seealso/><text> + <ref resolved='predef::begin_shared_string' to='begin_shared_string'>begin_shared_string</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='equal' homogen-type='method'> <method name='equal'/><doc placeholder='true'> <text>
2096: </doc> </docgroup> + <docgroup homogen-name='findstring' homogen-type='method'> + <method name='findstring'/><doc placeholder='true'> + <text> + <tt>findstring</tt> - find a string + + <tt>#include "stralloc.h" + + + struct pike_string *findstring(char *str); + + </tt> + This function looks for the null terminated C string 'str' in the + global hash table. It returns the shared string if found, otherwise + zero. It does not increase/decrease the references to the string. + + pike_string</text> + + <group><seealso/><text> + <ref to='make_shared_string'>make_shared_string</ref> and <ref resolved='predef::binary_findstring' to='binary_findstring'>binary_findstring</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='float' homogen-type='method'> <method name='float'/><doc placeholder='true'> <text>
2260: </doc> </docgroup> + <docgroup homogen-name='free_string' homogen-type='method'> + <method name='free_string'/><doc placeholder='true'> + <text> + <tt>free_string</tt> - free a pike string + + <tt>#include "stralloc.h" + + + void free_string(struct pike_string *p) + + </tt> + This function frees the string 'p'. What it actually does is that it + decreases the reference count of 'p' and frees the memory reserved + for it if the refereneces reach zero. + </text> + + <group><note/><text> + free_string is actually a macro + + pike_string</text></group> + + </doc> + </docgroup> <docgroup homogen-name='function' homogen-type='method'> <method name='function'/><doc placeholder='true'> <text>
3260: </doc> </docgroup> + <docgroup homogen-name='make_shared_binary_string' homogen-type='method'> + <method name='make_shared_binary_string'/><doc placeholder='true'> + <text> + <tt>make_shared_binary_string</tt> - make a shared string + + <tt>#include "stralloc.h" + + + struct pike_string *make_shared_binary_string(const char *str, int len); + + </tt> + This function makes a shared string from the memory area beginning + at 'str' and ends at str+len. The returned string will have one + extra reference. + + pike_string</text> + + <group><seealso/><text> + <ref to='make_shared_string'>make_shared_string</ref>, <ref resolved='predef::begin_shared_string' to='begin_shared_string'>begin_shared_string</ref>, <ref resolved='predef::push_string' to='push_string'>push_string</ref> and <ref resolved='predef::free_string' to='free_string'>free_string</ref> + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='make_shared_binary_string' homogen-type='method'> + <method name='make_shared_binary_string'/><doc placeholder='true'> + <text> + <tt>make_shared_binary_string</tt> - make a shared string + + <tt>#include "stralloc.h" + + + struct pike_string *make_shared_string(const char *str); + + </tt> + This function does the same thing as make_shared_binary_string, but + expects a zero terminated string instead. + + pike_string</text> + + <group><seealso/><text> + <ref resolved='predef::make_shared_binary_string' to='make_shared_binary_string'>make_shared_binary_string</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='map' homogen-type='method'> <method name='map'/><doc placeholder='true'> <text>
3620: </doc> </docgroup> + <docgroup homogen-name='my_strcmp' homogen-type='method'> + <method name='my_strcmp'/><doc placeholder='true'> + <text> + <tt>my_strcmp</tt> - my own strcmp function + + <tt>#include "stralloc.h" + + + int my_strcmp(struct pike_string *a, struct pike_string *b) + + </tt> + This function compares two pike strings and takes locales into + account if the system supports locales. It returns zero if the + strings are the same, a number greater than zero zero if 'a' + is greater than 'b', and a number below zero otherwise. + + pike_string</text> + + <group><seealso/><text> + <ref to='make_shared_string'>make_shared_string</ref> + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='next_object' homogen-type='method'> <method name='next_object'/><doc placeholder='true'> <text>
3857: </doc> </docgroup> + <docgroup homogen-name='pike_string' homogen-type='method'> + <method name='pike_string'/><doc placeholder='true'> + <text> + <tt>pike_string</tt> - internal pike shared strings + + This is the internal type for representing pike strings. They have + ref counts and they are shared though a global hash table. The C + type is a struct pike_string that has two public members: str and + len. str is an array of char which contain the actual string. It + is guaranteed that the string is null terminated, but the string + can also contain zeroes before the end. len is of course the + length of the string. Since strings are shared you may _never_ + modify the contents of a string, except for adding/subtracting + references when approperiate. The only exception to this is when + creating a new shared string with begin_shared_string which has + not yet been linked to the hash table with end_shared_string. + + internals</text> + + </doc> + </docgroup> <docgroup homogen-name='popen' homogen-type='method'> <method name='popen'/><doc placeholder='true'> <text>
3958: </doc> </docgroup> + <docgroup homogen-name='push_string' homogen-type='method'> + <method name='push_string'/><doc placeholder='true'> + <text> + <tt>push_string</tt> - push a string on the pike stack + + <tt>#include "interpret.h" + + + void push_string(struct pike_string *p) + + </tt> + <matrix> + <r><c> This function pushes the string p on the pike stack. Note that this </c></r> + <r><c> function does _not_ add any extra references to 'p'. Most functions </c></r> + <r><c> that create shared strings give one extra reference to them though. </c></r> + <r><c> If you get your string from a function that does not add extra </c><c> </c></r> + <r><c> references you will have to add a reference manually. </c></r> + </matrix> + + </text> + + <group><note/><text> + push_string is actually a macro + + pike_string</text></group> + + </doc> + </docgroup> <docgroup homogen-name='putenv' homogen-type='method'> <method name='putenv'/><doc placeholder='true'> <text>
4983: </doc> </docgroup> + <docgroup homogen-name='string_replace' homogen-type='method'> + <method name='string_replace'/><doc placeholder='true'> + <text> + <tt>string_replace</tt> - do string replacements + + <tt>#include "stralloc.h" + + + struct pike_string *string_replace(struct pike_string *str, + <dl><group><text>struct pike_string *from, + struct pike_string *to); + </text></group></dl> + </tt> + This function builds a new string from 'str' with all occurances + of 'from' replaced by 'to'. Note that the new string will have one + extra reference. + + pike_string</text> + + </doc> + </docgroup> <docgroup homogen-name='stringp' homogen-type='method'> <method name='stringp'/><doc placeholder='true'> <text>
7270: </doc> </docgroup> </class> + <class name='/precompiled/string_buffer'> + <doc placeholder='true'> + <text> + <tt>/precompiled/string_buffer</tt> - incremental string buffer + + string_buffer implements a fast way to build strings by appending + strings or chars to the end of the buffer. + </text> + + <group><bugs/><text> + This object is not thread-safe, if several threads access the same + buffer they have to protect the accesses with mutex locks. + + + </text></group> + + </doc> + <docgroup homogen-name='append' homogen-type='method'> + <method name='append'> + </method> + <doc placeholder='true'> + <text> + <tt>append</tt> - append a string to the buffer + + <tt>#include <string.h> + + + void string_buffer->append(string s); + + </tt> + This function appends the string s to the end of the buffer. + + + </text> + + </doc> + </docgroup> + <docgroup homogen-name='flush' homogen-type='method'> + <method name='flush'> + </method> + <doc placeholder='true'> + <text> + <tt>flush</tt> - flush the contents of the buffer + + <tt>#include <string.h> + + + void string_buffer->flush(); + + </tt> + This function empties the string buffer. You don't need to call this + function if you use the string buffer only once since the start + state for a string buffer is flushed. + + + </text> + + </doc> + </docgroup> + <docgroup homogen-name='get_buffer' homogen-type='method'> + <method name='get_buffer'> + </method> + <doc placeholder='true'> + <text> + <tt>get_buffer</tt> - get the contents of the buffer as a string. + + <tt>#include <string.h> + + + mixed string_buffer->get_buffer(); + or + (string)string_buffer; + + </tt> + This function retreives the content of the buffer. Note that it does + not clear the contents of the buffer. You have to do that yourself + with create(). + + + </text> + + </doc> + </docgroup> + </class> </namespace> </autodoc>

autodoc.git/ autodoc.xml

1996-10-13

1996-10-13 15:14:01 by Mirar (Pontus Hagland) <pike@sort.mirar.org>