summaryrefslogtreecommitdiff
path: root/doc/util_func.html
diff options
context:
space:
mode:
authorJed Barber <jjbarber@y7mail.com>2021-01-19 02:25:44 +1100
committerJed Barber <jjbarber@y7mail.com>2021-01-19 02:25:44 +1100
commitda389927ddf9240bbba10b819eb782e80a5d6bf7 (patch)
tree88b167b892de8c419151ca9a02c16f8d4ed96bec /doc/util_func.html
parent901c7e61278f16dc5c08cbebf74c2a816cd4b4b6 (diff)
Basic HTML documentation added
Diffstat (limited to 'doc/util_func.html')
-rw-r--r--doc/util_func.html148
1 files changed, 148 insertions, 0 deletions
diff --git a/doc/util_func.html b/doc/util_func.html
new file mode 100644
index 0000000..13d7c21
--- /dev/null
+++ b/doc/util_func.html
@@ -0,0 +1,148 @@
+
+<!DOCTYPE html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Utility Functions - Packrat Docs</title>
+ <link href="default.css" rel="stylesheet">
+ </head>
+
+ <body>
+
+
+ <h2>Utility Functions</h2>
+
+ <a href="index.html">Return to Contents</a>
+
+
+ <p>These are intended as helper functions for use with <em>Satisfy</em> combinators and the like
+ when parsing ordinary strings.</p>
+
+ <table>
+ <tr>
+<td><pre>
+generic
+ Set : in Ada.Strings.Maps.Character_Set;
+function In_Set
+ (Element : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is present within the given <em>Character_Set</em>.</td>
+ </tr>
+ <tr>
+<td><pre>
+generic
+ Set : in Ada.Strings.Maps.Character_Set;
+function Not_In_Set
+ (Element : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is not present within the given <em>Character_Set</em>.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_Digit
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is one of the digits 0 through 9.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_Hex
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is one of the digits 0 through 9 or one of the letters
+A through F, case insensitive.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_Letter
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is one of the letters A through Z, case insensitive.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_Alphanumeric
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is one of the digits 0 through 9 or one of the letters
+A through Z, case insensitive.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_Punctuation
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is one of the punctuation characters <em>! &quot; # $ %
+&amp; &apos; ( ) * + , - . / : ; &lt; = &gt; ? @ [ \ ] ^ _ ` { | } ~</em> which annoyingly
+occupies several disjoint sections of ASCII.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_ASCII
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is in the lower half of the ASCII character set.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_Extended_ASCII
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is in the upper half of the ASCII character set.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_Space
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is a space.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_Linespace
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is a space or horizontal tab.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_End_Of_Line
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is a linefeed or carriage return.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Is_Whitespace
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is a space, horizontal tab, linefeed, or carriage return.</td>
+ </tr>
+ <tr>
+<td><pre>
+function Not_Whitespace
+ (Char : in Character)
+ return Boolean;
+</pre></td>
+<td>Tests whether a <em>Character</em> is not a space, horizontal tab, linefeed, or carriage return.</td>
+ </tr>
+ </table>
+
+
+ </body>
+</html>
+