From 29bc09d70361ff75d060bc58d8ef0424693504da Mon Sep 17 00:00:00 2001 From: Lukas Mai Date: Tue, 27 Mar 2012 01:03:57 +0200 Subject: [PATCH] documentation for extended capability stuff --- doc/unibi_add_ext_bool.pod | 36 +++++++++++++++++++++++++++++ doc/unibi_add_ext_num.pod | 36 +++++++++++++++++++++++++++++ doc/unibi_add_ext_str.pod | 36 +++++++++++++++++++++++++++++ doc/unibi_count_ext_bool.pod | 28 +++++++++++++++++++++++ doc/unibi_count_ext_num.pod | 28 +++++++++++++++++++++++ doc/unibi_count_ext_str.pod | 28 +++++++++++++++++++++++ doc/unibi_del_ext_bool.pod | 29 ++++++++++++++++++++++++ doc/unibi_dump.pod | 4 ++-- doc/unibi_from_mem.pod | 7 ++++-- doc/unibi_get_ext_bool.pod | 33 +++++++++++++++++++++++++++ doc/unibi_get_ext_bool_name.pod | 36 +++++++++++++++++++++++++++++ doc/unibi_get_ext_num.pod | 33 +++++++++++++++++++++++++++ doc/unibi_get_ext_num_name.pod | 36 +++++++++++++++++++++++++++++ doc/unibi_get_ext_str.pod | 33 +++++++++++++++++++++++++++ doc/unibi_get_ext_str_name.pod | 36 +++++++++++++++++++++++++++++ doc/unibi_set_ext_bool.pod | 33 +++++++++++++++++++++++++++ doc/unibi_set_ext_bool_name.pod | 36 +++++++++++++++++++++++++++++ doc/unibi_set_ext_num.pod | 33 +++++++++++++++++++++++++++ doc/unibi_set_ext_num_name.pod | 36 +++++++++++++++++++++++++++++ doc/unibi_set_ext_str.pod | 33 +++++++++++++++++++++++++++ doc/unibi_set_ext_str_name.pod | 36 +++++++++++++++++++++++++++++ doc/unibilium.h.pod | 40 +++++++++++++++++++++++++++++++-- 22 files changed, 680 insertions(+), 6 deletions(-) create mode 100644 doc/unibi_add_ext_bool.pod create mode 100644 doc/unibi_add_ext_num.pod create mode 100644 doc/unibi_add_ext_str.pod create mode 100644 doc/unibi_count_ext_bool.pod create mode 100644 doc/unibi_count_ext_num.pod create mode 100644 doc/unibi_count_ext_str.pod create mode 100644 doc/unibi_del_ext_bool.pod create mode 100644 doc/unibi_get_ext_bool.pod create mode 100644 doc/unibi_get_ext_bool_name.pod create mode 100644 doc/unibi_get_ext_num.pod create mode 100644 doc/unibi_get_ext_num_name.pod create mode 100644 doc/unibi_get_ext_str.pod create mode 100644 doc/unibi_get_ext_str_name.pod create mode 100644 doc/unibi_set_ext_bool.pod create mode 100644 doc/unibi_set_ext_bool_name.pod create mode 100644 doc/unibi_set_ext_num.pod create mode 100644 doc/unibi_set_ext_num_name.pod create mode 100644 doc/unibi_set_ext_str.pod create mode 100644 doc/unibi_set_ext_str_name.pod diff --git a/doc/unibi_add_ext_bool.pod b/doc/unibi_add_ext_bool.pod new file mode 100644 index 0000000..61880cf --- /dev/null +++ b/doc/unibi_add_ext_bool.pod @@ -0,0 +1,36 @@ +=pod + +=head1 NAME + +unibi_add_ext_bool, unibi_add_ext_num, unibi_add_ext_str - add extended capabilities to a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + size_t unibi_add_ext_bool(unibi_term *ut, const char *t, int b); + size_t unibi_add_ext_num(unibi_term *ut, const char *t, short v); + size_t unibi_add_ext_str(unibi_term *ut, const char *t, const char *s); + +=head1 DESCRIPTION + +Add an extended boolean, numeric, or string capability with the specified +name and value. + +Note that these functions simply store any pointers they are given. They will +not free I or I or copy any strings. + +=head1 RETURN VALUE + +The return value is the index of the new capability, which can be used in +L, L, etc. If an error occurs, +C is returned. + +=head1 SEE ALSO + +L, +L, +L, +L + +=cut diff --git a/doc/unibi_add_ext_num.pod b/doc/unibi_add_ext_num.pod new file mode 100644 index 0000000..61880cf --- /dev/null +++ b/doc/unibi_add_ext_num.pod @@ -0,0 +1,36 @@ +=pod + +=head1 NAME + +unibi_add_ext_bool, unibi_add_ext_num, unibi_add_ext_str - add extended capabilities to a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + size_t unibi_add_ext_bool(unibi_term *ut, const char *t, int b); + size_t unibi_add_ext_num(unibi_term *ut, const char *t, short v); + size_t unibi_add_ext_str(unibi_term *ut, const char *t, const char *s); + +=head1 DESCRIPTION + +Add an extended boolean, numeric, or string capability with the specified +name and value. + +Note that these functions simply store any pointers they are given. They will +not free I or I or copy any strings. + +=head1 RETURN VALUE + +The return value is the index of the new capability, which can be used in +L, L, etc. If an error occurs, +C is returned. + +=head1 SEE ALSO + +L, +L, +L, +L + +=cut diff --git a/doc/unibi_add_ext_str.pod b/doc/unibi_add_ext_str.pod new file mode 100644 index 0000000..61880cf --- /dev/null +++ b/doc/unibi_add_ext_str.pod @@ -0,0 +1,36 @@ +=pod + +=head1 NAME + +unibi_add_ext_bool, unibi_add_ext_num, unibi_add_ext_str - add extended capabilities to a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + size_t unibi_add_ext_bool(unibi_term *ut, const char *t, int b); + size_t unibi_add_ext_num(unibi_term *ut, const char *t, short v); + size_t unibi_add_ext_str(unibi_term *ut, const char *t, const char *s); + +=head1 DESCRIPTION + +Add an extended boolean, numeric, or string capability with the specified +name and value. + +Note that these functions simply store any pointers they are given. They will +not free I or I or copy any strings. + +=head1 RETURN VALUE + +The return value is the index of the new capability, which can be used in +L, L, etc. If an error occurs, +C is returned. + +=head1 SEE ALSO + +L, +L, +L, +L + +=cut diff --git a/doc/unibi_count_ext_bool.pod b/doc/unibi_count_ext_bool.pod new file mode 100644 index 0000000..afbd521 --- /dev/null +++ b/doc/unibi_count_ext_bool.pod @@ -0,0 +1,28 @@ +=pod + +=head1 NAME + +unibi_count_ext_bool, unibi_count_ext_num, unibi_count_ext_str - count extended terminal capabilities + +=head1 SYNOPSIS + + #include "unibilium.h" + + size_t unibi_count_ext_bool(const unibi_term *ut); + size_t unibi_count_ext_num(const unibi_term *ut); + size_t unibi_count_ext_str(const unibi_term *ut); + +=head1 DESCRIPTION + +These functions count the number of extended (i.e. user specified) +capabilities of the respective type in I. + +=head1 RETURN VALUE + +The number of extended capabilities. + +=head1 SEE ALSO + +L + +=cut diff --git a/doc/unibi_count_ext_num.pod b/doc/unibi_count_ext_num.pod new file mode 100644 index 0000000..afbd521 --- /dev/null +++ b/doc/unibi_count_ext_num.pod @@ -0,0 +1,28 @@ +=pod + +=head1 NAME + +unibi_count_ext_bool, unibi_count_ext_num, unibi_count_ext_str - count extended terminal capabilities + +=head1 SYNOPSIS + + #include "unibilium.h" + + size_t unibi_count_ext_bool(const unibi_term *ut); + size_t unibi_count_ext_num(const unibi_term *ut); + size_t unibi_count_ext_str(const unibi_term *ut); + +=head1 DESCRIPTION + +These functions count the number of extended (i.e. user specified) +capabilities of the respective type in I. + +=head1 RETURN VALUE + +The number of extended capabilities. + +=head1 SEE ALSO + +L + +=cut diff --git a/doc/unibi_count_ext_str.pod b/doc/unibi_count_ext_str.pod new file mode 100644 index 0000000..afbd521 --- /dev/null +++ b/doc/unibi_count_ext_str.pod @@ -0,0 +1,28 @@ +=pod + +=head1 NAME + +unibi_count_ext_bool, unibi_count_ext_num, unibi_count_ext_str - count extended terminal capabilities + +=head1 SYNOPSIS + + #include "unibilium.h" + + size_t unibi_count_ext_bool(const unibi_term *ut); + size_t unibi_count_ext_num(const unibi_term *ut); + size_t unibi_count_ext_str(const unibi_term *ut); + +=head1 DESCRIPTION + +These functions count the number of extended (i.e. user specified) +capabilities of the respective type in I. + +=head1 RETURN VALUE + +The number of extended capabilities. + +=head1 SEE ALSO + +L + +=cut diff --git a/doc/unibi_del_ext_bool.pod b/doc/unibi_del_ext_bool.pod new file mode 100644 index 0000000..ef1526c --- /dev/null +++ b/doc/unibi_del_ext_bool.pod @@ -0,0 +1,29 @@ +=pod + +=head1 NAME + +unibi_del_ext_bool, unibi_del_ext_num, unibi_del_ext_str - remove extended capabilities from a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + void unibi_del_ext_bool(unibi_term *ut, size_t i); + void unibi_del_ext_num(unibi_term *ut, size_t i); + void unibi_del_ext_str(unibi_term *ut, size_t i); + +=head1 DESCRIPTION + +Remove an extended boolean, numeric, or string capability. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +=head1 SEE ALSO + +L, +L, +L, +L + +=cut diff --git a/doc/unibi_dump.pod b/doc/unibi_dump.pod index 4574c09..3429dd0 100644 --- a/doc/unibi_dump.pod +++ b/doc/unibi_dump.pod @@ -19,8 +19,8 @@ written to I

, which must have room for at least I bytes. C returns the number of bytes required to store the terminfo data. If this exceeds I, nothing is written to I

. If the terminal object can't -be represented in terminfo format (string table too large), the return value is -C. +be represented in terminfo format (e.g. because the string table would be too +large), the return value is C. =head1 ERRORS diff --git a/doc/unibi_from_mem.pod b/doc/unibi_from_mem.pod index 3662275..794a222 100644 --- a/doc/unibi_from_mem.pod +++ b/doc/unibi_from_mem.pod @@ -12,11 +12,14 @@ unibi_from_mem - construct a terminal object from a compiled terminfo entry =head1 DESCRIPTION -This function parses a compiled terminfo entry that starts at I

and is I bytes long and constructs a C object from it. When you're done with it, you should call C to free it. +This function parses a compiled terminfo entry that starts at I

and is I +bytes long and constructs a C object from it. When you're done with +it, you should call C to free it. =head1 RETURN VALUE -A pointer to a new C. In case of failure, C is returned and C is set. +A pointer to a new C. In case of failure, C is returned and +C is set. =head1 ERRORS diff --git a/doc/unibi_get_ext_bool.pod b/doc/unibi_get_ext_bool.pod new file mode 100644 index 0000000..054da37 --- /dev/null +++ b/doc/unibi_get_ext_bool.pod @@ -0,0 +1,33 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool, unibi_set_ext_bool, unibi_get_ext_num, unibi_set_ext_num, unibi_get_ext_str, unibi_set_ext_str - access the extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + int unibi_get_ext_bool(const unibi_term *ut, size_t i); + short unibi_get_ext_num(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool(unibi_term *ut, size_t i, int b); + void unibi_set_ext_num(unibi_term *ut, size_t i, short v); + void unibi_set_ext_str(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that C simply stores the pointer it is given; it will +not free I or make a copy of the string. + +=head1 SEE ALSO + +L + +=cut diff --git a/doc/unibi_get_ext_bool_name.pod b/doc/unibi_get_ext_bool_name.pod new file mode 100644 index 0000000..aa6cca3 --- /dev/null +++ b/doc/unibi_get_ext_bool_name.pod @@ -0,0 +1,36 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool_name, unibi_set_ext_bool_name, unibi_get_ext_num_name, unibi_set_ext_num_name, unibi_get_ext_str_name, unibi_set_ext_str_name - access the names of extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + const char *unibi_get_ext_bool_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_num_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str_name(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_num_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_str_name(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set the names of extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that +C/C/C +simply store the pointer they are given; they will not free I or make a +copy of the string. + +=head1 SEE ALSO + +L + +=cut + diff --git a/doc/unibi_get_ext_num.pod b/doc/unibi_get_ext_num.pod new file mode 100644 index 0000000..054da37 --- /dev/null +++ b/doc/unibi_get_ext_num.pod @@ -0,0 +1,33 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool, unibi_set_ext_bool, unibi_get_ext_num, unibi_set_ext_num, unibi_get_ext_str, unibi_set_ext_str - access the extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + int unibi_get_ext_bool(const unibi_term *ut, size_t i); + short unibi_get_ext_num(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool(unibi_term *ut, size_t i, int b); + void unibi_set_ext_num(unibi_term *ut, size_t i, short v); + void unibi_set_ext_str(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that C simply stores the pointer it is given; it will +not free I or make a copy of the string. + +=head1 SEE ALSO + +L + +=cut diff --git a/doc/unibi_get_ext_num_name.pod b/doc/unibi_get_ext_num_name.pod new file mode 100644 index 0000000..aa6cca3 --- /dev/null +++ b/doc/unibi_get_ext_num_name.pod @@ -0,0 +1,36 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool_name, unibi_set_ext_bool_name, unibi_get_ext_num_name, unibi_set_ext_num_name, unibi_get_ext_str_name, unibi_set_ext_str_name - access the names of extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + const char *unibi_get_ext_bool_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_num_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str_name(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_num_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_str_name(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set the names of extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that +C/C/C +simply store the pointer they are given; they will not free I or make a +copy of the string. + +=head1 SEE ALSO + +L + +=cut + diff --git a/doc/unibi_get_ext_str.pod b/doc/unibi_get_ext_str.pod new file mode 100644 index 0000000..054da37 --- /dev/null +++ b/doc/unibi_get_ext_str.pod @@ -0,0 +1,33 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool, unibi_set_ext_bool, unibi_get_ext_num, unibi_set_ext_num, unibi_get_ext_str, unibi_set_ext_str - access the extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + int unibi_get_ext_bool(const unibi_term *ut, size_t i); + short unibi_get_ext_num(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool(unibi_term *ut, size_t i, int b); + void unibi_set_ext_num(unibi_term *ut, size_t i, short v); + void unibi_set_ext_str(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that C simply stores the pointer it is given; it will +not free I or make a copy of the string. + +=head1 SEE ALSO + +L + +=cut diff --git a/doc/unibi_get_ext_str_name.pod b/doc/unibi_get_ext_str_name.pod new file mode 100644 index 0000000..aa6cca3 --- /dev/null +++ b/doc/unibi_get_ext_str_name.pod @@ -0,0 +1,36 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool_name, unibi_set_ext_bool_name, unibi_get_ext_num_name, unibi_set_ext_num_name, unibi_get_ext_str_name, unibi_set_ext_str_name - access the names of extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + const char *unibi_get_ext_bool_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_num_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str_name(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_num_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_str_name(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set the names of extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that +C/C/C +simply store the pointer they are given; they will not free I or make a +copy of the string. + +=head1 SEE ALSO + +L + +=cut + diff --git a/doc/unibi_set_ext_bool.pod b/doc/unibi_set_ext_bool.pod new file mode 100644 index 0000000..054da37 --- /dev/null +++ b/doc/unibi_set_ext_bool.pod @@ -0,0 +1,33 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool, unibi_set_ext_bool, unibi_get_ext_num, unibi_set_ext_num, unibi_get_ext_str, unibi_set_ext_str - access the extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + int unibi_get_ext_bool(const unibi_term *ut, size_t i); + short unibi_get_ext_num(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool(unibi_term *ut, size_t i, int b); + void unibi_set_ext_num(unibi_term *ut, size_t i, short v); + void unibi_set_ext_str(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that C simply stores the pointer it is given; it will +not free I or make a copy of the string. + +=head1 SEE ALSO + +L + +=cut diff --git a/doc/unibi_set_ext_bool_name.pod b/doc/unibi_set_ext_bool_name.pod new file mode 100644 index 0000000..aa6cca3 --- /dev/null +++ b/doc/unibi_set_ext_bool_name.pod @@ -0,0 +1,36 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool_name, unibi_set_ext_bool_name, unibi_get_ext_num_name, unibi_set_ext_num_name, unibi_get_ext_str_name, unibi_set_ext_str_name - access the names of extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + const char *unibi_get_ext_bool_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_num_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str_name(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_num_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_str_name(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set the names of extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that +C/C/C +simply store the pointer they are given; they will not free I or make a +copy of the string. + +=head1 SEE ALSO + +L + +=cut + diff --git a/doc/unibi_set_ext_num.pod b/doc/unibi_set_ext_num.pod new file mode 100644 index 0000000..054da37 --- /dev/null +++ b/doc/unibi_set_ext_num.pod @@ -0,0 +1,33 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool, unibi_set_ext_bool, unibi_get_ext_num, unibi_set_ext_num, unibi_get_ext_str, unibi_set_ext_str - access the extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + int unibi_get_ext_bool(const unibi_term *ut, size_t i); + short unibi_get_ext_num(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool(unibi_term *ut, size_t i, int b); + void unibi_set_ext_num(unibi_term *ut, size_t i, short v); + void unibi_set_ext_str(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that C simply stores the pointer it is given; it will +not free I or make a copy of the string. + +=head1 SEE ALSO + +L + +=cut diff --git a/doc/unibi_set_ext_num_name.pod b/doc/unibi_set_ext_num_name.pod new file mode 100644 index 0000000..aa6cca3 --- /dev/null +++ b/doc/unibi_set_ext_num_name.pod @@ -0,0 +1,36 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool_name, unibi_set_ext_bool_name, unibi_get_ext_num_name, unibi_set_ext_num_name, unibi_get_ext_str_name, unibi_set_ext_str_name - access the names of extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + const char *unibi_get_ext_bool_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_num_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str_name(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_num_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_str_name(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set the names of extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that +C/C/C +simply store the pointer they are given; they will not free I or make a +copy of the string. + +=head1 SEE ALSO + +L + +=cut + diff --git a/doc/unibi_set_ext_str.pod b/doc/unibi_set_ext_str.pod new file mode 100644 index 0000000..054da37 --- /dev/null +++ b/doc/unibi_set_ext_str.pod @@ -0,0 +1,33 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool, unibi_set_ext_bool, unibi_get_ext_num, unibi_set_ext_num, unibi_get_ext_str, unibi_set_ext_str - access the extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + int unibi_get_ext_bool(const unibi_term *ut, size_t i); + short unibi_get_ext_num(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool(unibi_term *ut, size_t i, int b); + void unibi_set_ext_num(unibi_term *ut, size_t i, short v); + void unibi_set_ext_str(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that C simply stores the pointer it is given; it will +not free I or make a copy of the string. + +=head1 SEE ALSO + +L + +=cut diff --git a/doc/unibi_set_ext_str_name.pod b/doc/unibi_set_ext_str_name.pod new file mode 100644 index 0000000..aa6cca3 --- /dev/null +++ b/doc/unibi_set_ext_str_name.pod @@ -0,0 +1,36 @@ +=pod + +=head1 NAME + +unibi_get_ext_bool_name, unibi_set_ext_bool_name, unibi_get_ext_num_name, unibi_set_ext_num_name, unibi_get_ext_str_name, unibi_set_ext_str_name - access the names of extended capabilities of a terminal object + +=head1 SYNOPSIS + + #include "unibilium.h" + + const char *unibi_get_ext_bool_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_num_name(const unibi_term *ut, size_t i); + const char *unibi_get_ext_str_name(const unibi_term *ut, size_t i); + + void unibi_set_ext_bool_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_num_name(unibi_term *ut, size_t i, const char *s); + void unibi_set_ext_str_name(unibi_term *ut, size_t i, const char *s); + +=head1 DESCRIPTION + +Get/set the names of extended boolean, numeric, and string capabilities. +I is the index of the extended capability to act on; it must be less than +C, C, or +C, respectively. + +Note that +C/C/C +simply store the pointer they are given; they will not free I or make a +copy of the string. + +=head1 SEE ALSO + +L + +=cut + diff --git a/doc/unibilium.h.pod b/doc/unibilium.h.pod index 7e56baa..d82b83c 100644 --- a/doc/unibilium.h.pod +++ b/doc/unibilium.h.pod @@ -121,6 +121,11 @@ An enumeration of boolean capabilities. It has the following elements: =back +The special values C and C are +provided to make it easier for programs to loop over all boolean capabilities. +All of the enum values listed above are greater than C +and less than C. + =item enum unibi_numeric An enumeration of numeric capabilities. It has the following elements: @@ -206,7 +211,12 @@ An enumeration of numeric capabilities. It has the following elements: =item C =back - + +The special values C and C are +provided to make it easier for programs to loop over all numeric capabilities. +All of the enum values listed above are greater than C +and less than C. + =item enum unibi_string An enumeration of string capabilities. It has the following elements: @@ -1043,6 +1053,11 @@ An enumeration of string capabilities. It has the following elements: =back +The special values C and C are +provided to make it easier for programs to loop over all string capabilities. +All of the enum values listed above are greater than C +and less than C. + =back =head1 SEE ALSO @@ -1073,6 +1088,27 @@ L, L, L, L, -L +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L =cut