diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-12 10:23:59 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-12 10:25:14 +0200 |
commit | 108a0454d05c744c4a05e298cfc8cbf157952414 (patch) | |
tree | ca99bed5d49eabfb644c3b1c0a397b1354efdaf3 /doc/ref/guile | |
parent | Change overarching structure of info document. (diff) | |
download | calp-108a0454d05c744c4a05e298cfc8cbf157952414.tar.gz calp-108a0454d05c744c4a05e298cfc8cbf157952414.tar.xz |
Rework file tree structure for info files.
Diffstat (limited to '')
-rw-r--r-- | doc/ref/general/base64.texi (renamed from doc/ref/guile/base64.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/crypto.texi (renamed from doc/ref/guile/crypto.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/datetime.texi (renamed from doc/ref/guile/datetime.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/glob.texi (renamed from doc/ref/guile/glob.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/graphviz.texi (renamed from doc/ref/guile/graphviz.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/srfi-41.texi (renamed from doc/ref/guile/srfi-41.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/util-config.texi (renamed from doc/ref/guile/util-config.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/util-exceptions.texi (renamed from doc/ref/guile/util-exceptions.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/util-path.texi (renamed from doc/ref/guile/util-path.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/util.texi (renamed from doc/ref/guile/util.texi) | 88 | ||||
-rw-r--r-- | doc/ref/general/xdg-basedir.texi (renamed from doc/ref/guile/xdg-basedir.texi) | 0 | ||||
-rw-r--r-- | doc/ref/general/zic.texi (renamed from doc/ref/guile/zic.texi) | 0 | ||||
-rw-r--r-- | doc/ref/guile/translation.texi | 31 | ||||
-rw-r--r-- | doc/ref/guile/vcomponent.texi | 117 | ||||
-rw-r--r-- | doc/ref/web/web.texi (renamed from doc/ref/guile/web.texi) | 0 |
15 files changed, 0 insertions, 236 deletions
diff --git a/doc/ref/guile/base64.texi b/doc/ref/general/base64.texi index ab6bba81..ab6bba81 100644 --- a/doc/ref/guile/base64.texi +++ b/doc/ref/general/base64.texi diff --git a/doc/ref/guile/crypto.texi b/doc/ref/general/crypto.texi index b9e362d3..b9e362d3 100644 --- a/doc/ref/guile/crypto.texi +++ b/doc/ref/general/crypto.texi diff --git a/doc/ref/guile/datetime.texi b/doc/ref/general/datetime.texi index 037ac8d5..037ac8d5 100644 --- a/doc/ref/guile/datetime.texi +++ b/doc/ref/general/datetime.texi diff --git a/doc/ref/guile/glob.texi b/doc/ref/general/glob.texi index 400eb1f7..400eb1f7 100644 --- a/doc/ref/guile/glob.texi +++ b/doc/ref/general/glob.texi diff --git a/doc/ref/guile/graphviz.texi b/doc/ref/general/graphviz.texi index 72817ea8..72817ea8 100644 --- a/doc/ref/guile/graphviz.texi +++ b/doc/ref/general/graphviz.texi diff --git a/doc/ref/guile/srfi-41.texi b/doc/ref/general/srfi-41.texi index d8020ecc..d8020ecc 100644 --- a/doc/ref/guile/srfi-41.texi +++ b/doc/ref/general/srfi-41.texi diff --git a/doc/ref/guile/util-config.texi b/doc/ref/general/util-config.texi index 2e197bcc..2e197bcc 100644 --- a/doc/ref/guile/util-config.texi +++ b/doc/ref/general/util-config.texi diff --git a/doc/ref/guile/util-exceptions.texi b/doc/ref/general/util-exceptions.texi index 34ba33f9..34ba33f9 100644 --- a/doc/ref/guile/util-exceptions.texi +++ b/doc/ref/general/util-exceptions.texi diff --git a/doc/ref/guile/util-path.texi b/doc/ref/general/util-path.texi index 384915ef..384915ef 100644 --- a/doc/ref/guile/util-path.texi +++ b/doc/ref/general/util-path.texi diff --git a/doc/ref/guile/util.texi b/doc/ref/general/util.texi index d4dce3a6..bae19987 100644 --- a/doc/ref/guile/util.texi +++ b/doc/ref/general/util.texi @@ -357,91 +357,3 @@ Port of Common Lisp's @code{begin1} form. Like @code{begin} runs each form in its body in order, but returns the first result instead of the last. @end defmac - -@node UUIDs -@section UUID generation - -Provided by module @code{(hnh util uuid)}. - -@defun uuid-v4 -Generates a UUID-v4 string. -@end defun - -@defun uuid -Generates an implementation defined (but guaranteed valid) UUID. -@end defun - -@deftp {parameter} seed -Guile parameter containing the seed used when generating UUID's in -this module. Only set this when you want non-random randomness. -@end deftp - -@node IO operations -@section IO - -Provided by module @code{(hnh util io)}. - -@defun open-input-port path -@defunx open-output-port path -Like @code{open-*-file}, but ``-'' gives @code{standard-@{input,output@}}. -@end defun - -@defun read-lines port -Return a list of all lines read from port. -@end defun - -@defun with-atomic-output-to-file filename thunk -Same functionality as the regular @var{with-output-to-file}, but -with the difference that either everything is written, or nothing -is written, and if anything is written it's all written atomicaly at -once (the original file will never contain an intermidiate state). -Does NOT handle race conditions between threads. - -propagates the return value of @var{thunk} upon successfully writing -the file, and @code{#f} otherwise. -@end defun - -@defun call-with-tmpfile proc [#:tmpl ``/tmp/file-XXXXXXX''] -@end defun - -@defun read-file path -Open file at path, and return its content as a string. -@end defun - -@node Binary Search Tree -@section Binary Search Tree - -A simple ``read only'' binary search tree. - -@defun make-tree pred? lst -Constructs a new tree. @var{pred?} should be a procedure taking the -first element of @var{lst}, along with each element, and should return -a boolean value indicating if the specific element should go in the -left or right subtree. (left subtree is ``truthy'' values). - -This operation is done recursively. -@end defun - -@defun tree-node tree -Return the value of a tree node. -@end defun - -@defun left-subtree tree -Return all ``truthy'' children of tree node. -@end defun - -@defun right-subtree tree -Return all ``falsy children of tree node. -@end defun - -@defun length-of-longest-branch tree -Get the depth of a tree. -@end defun - -@defun tree-map proc tree -Apply proc onto the value of every node in tree, keeping the structure -of the tree. - -@b{Note:} this can cause the tree to no longer be a binary search -tree, but simply a ``formless'' binary tree. -@end defun diff --git a/doc/ref/guile/xdg-basedir.texi b/doc/ref/general/xdg-basedir.texi index 2d3b2972..2d3b2972 100644 --- a/doc/ref/guile/xdg-basedir.texi +++ b/doc/ref/general/xdg-basedir.texi diff --git a/doc/ref/guile/zic.texi b/doc/ref/general/zic.texi index 5af36fd3..5af36fd3 100644 --- a/doc/ref/guile/zic.texi +++ b/doc/ref/general/zic.texi diff --git a/doc/ref/guile/translation.texi b/doc/ref/guile/translation.texi deleted file mode 100644 index 0e710c47..00000000 --- a/doc/ref/guile/translation.texi +++ /dev/null @@ -1,31 +0,0 @@ -@node Translation -@section Translation - -Base for string translation in the application. Calp uses Guile's -built in gettext bindings. The text domain used is ``calp''. - -@defun translate str -@anchor{translate} -Translate a string from english into an (through enviroment) specified -target language. All newlines in the source string will be changed to -spaces. - -This procedure is both used as the ``backend'' for @ref{G_}, but also -for non-literal strings which should be translated. -@end defun - -@defun G_ msg ... -@anchor{G_} -The ``global'' binding indicating a string to be translated. - -All arguments must be strings, and will be concatenated before being -passed to @ref{translate} (meaning newlines will be ignored). -@end defun - -@defun yes-no-check string [locale=%global-locale] -Checks @var{string} if it's a yes or no response in the given -@var{locale}. - -Returns @code{'yes} or @code{'no}, or @code{#f} if the string couldn't -be parsed as a yes/no predicate in the current locale. -@end defun diff --git a/doc/ref/guile/vcomponent.texi b/doc/ref/guile/vcomponent.texi deleted file mode 100644 index a0f3438e..00000000 --- a/doc/ref/guile/vcomponent.texi +++ /dev/null @@ -1,117 +0,0 @@ -@node VComponent -@section (vcomponent) - -@defvr {Configuration Variable} calendar-files -List of filepaths -@end defvr - -@defvr {Configuration Variable} default-calendar -@end defvr - -@c ===== Concepts ===== - -@c - internal fields -@c DATA layout -@c how does multiple value work? - -@c ===== BASE ===== - -@deftp {Record Type} <vline> - -@c - key -@c - value -@c - parameters -@c - source - -@defun make-vline key value [ht=(make-hash-table)] -@var{ht} is the hash table storing the parameters, can be explicitly -given if need for optimizations arrises. -@end defun - -@defun vline? x -@end defun - -@defun vline-key vline -@end defun - -@deffn {Slot} vline-source vline -@end deffn - -@deffn {Slot} value vline -@end deffn - -@deffn {Slot} param vline key -@end deffn - -@defun delete-parameter! vline key -@end defun - -@defun parameters vline -Key a list of all parameters -@example -((key value) ...) -@end example -@end defun - -@end deftp - - -@deftp {Record Type} <vcomponent> - -@defun vcomponent? x -@end defun - -@defun make-vcomponent [type='VIRTUAL] -@end defun - -@defun children vcomponent -Returns all direct children of vcomponent, as a list of vcomponents. -@end defun - -@deffn {Slot} parent vcomonent -@end deffn - -@defun type vcomponent -Returns the type of this vcomponent, as a symbol. Probably one of -@code{VCALENDAR}, @code{VEVENT}, ... -@end defun - -@defun add-child! parent child -Adds child to the parents child list, but also updates the child to -have parent in its parent slot -@end defun - -@deffn {Prop} prop* vcomponent key -@deffnx {Prop} prop vcomponent key -@var{prop*} return the vline object, while @var{prop} is equivalent to -@lisp -(value (prop* vcomponent key)) -@end lisp -@end deffn - -@defun {(extract field)} vcomponent -@defunx {(extract* field)} vcomponent -Curried version of @var{prop}. -@end defun - -@defun delete-property! component key -@end defun - -@defun properties comopnent -@example -((key . value) ...) -@end example -@end defun - -@end deftp - -@defun copy-vcomponent vcomponent -@end defun - - -@defun x-property? symb -Does symbol start with ``X-''? -@end defun - -@defun internal-field? symb [prefix="-"] -@end defun diff --git a/doc/ref/guile/web.texi b/doc/ref/web/web.texi index 69ab726f..69ab726f 100644 --- a/doc/ref/guile/web.texi +++ b/doc/ref/web/web.texi |