Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Files | Macros | Functions

Files

file  afw_ascii.h
 Adaptive Framework ASCII.
 

Macros

#define AFW_ASCII_NUL   0x00
 NULL character.
 
#define AFW_ASCII_SOH   0x01
 Start of Heading.
 
#define AFW_ASCII_STX   0x02
 Start of Text.
 
#define AFW_ASCII_ETX   0x03
 End of Text.
 
#define AFW_ASCII_EOT   0x04
 End of Transmission.
 
#define AFW_ASCII_ENQ   0x05
 ENQuiry.
 
#define AFW_ASCII_ACK   0x06
 ACKnowledge.
 
#define AFW_ASCII_BEL   0x07
 Bell.
 
#define AFW_ASCII_BS   0x08
 BackSpace (non-destructive)
 
#define AFW_ASCII_HT   0x09
 Horizontal Tab.
 
#define AFW_ASCII_LF   0x0A
 Line Feed.
 
#define AFW_ASCII_VT   0x0B
 Vertical Tab.
 
#define AFW_ASCII_FF   0x0C
 Form Feed.
 
#define AFW_ASCII_CR   0x0D
 Carriage Return.
 
#define AFW_ASCII_SO   0x0E
 Shift Out.
 
#define AFW_ASCII_SI   0x0F
 Shift In.
 
#define AFW_ASCII_DLE   0x10
 Data Link Escape.
 
#define AFW_ASCII_DC1   0x11
 Device Control 1 (XON)
 
#define AFW_ASCII_DC2   0x12
 Device Control 2.
 
#define AFW_ASCII_DC3   0x13
 Device Control 3 (XOFF)
 
#define AFW_ASCII_DC4   0x14
 Device Control 4.
 
#define AFW_ASCII_NAK   0x15
 Negative Acknowledge.
 
#define AFW_ASCII_SYN   0x16
 Synchronize idle.
 
#define AFW_ASCII_ETB   0x17
 End Transmission Block.
 
#define AFW_ASCII_CAN   0x18
 Cancel Line.
 
#define AFW_ASCII_EM   0x19
 End of Media.
 
#define AFW_ASCII_SUB   0x1A
 Substitute.
 
#define AFW_ASCII_ESC   0x1B
 Escape.
 
#define AFW_ASCII_FS   0x1C
 File Separator.
 
#define AFW_ASCII_GS   0x1D
 Group Separator.
 
#define AFW_ASCII_RS   0x1E
 Record Separator.
 
#define AFW_ASCII_US   0x1F
 Unit Separator.
 
#define AFW_ASCII_DELETE   0x7F
 Delete.
 
#define AFW_ASCII_Z_PATH_SEPARATOR   "/"
 Path separator.
 
#define AFW_ASCII_PATH_SEPARATOR   '/'
 
#define afw_ascii_is_printable(v)    ( ((v)>=AFW_ASCII_SPACE) && ((v)<=AFW_ASCII_TILDE) )
 Determine if octet is ascii printable character. More...
 
#define afw_ascii_is_lowercase(v)    ( ((v) >= 'a') && ((v) <= 'z') )
 Determine if octet is ascii lowercase character. More...
 
#define afw_ascii_is_uppercase(v)    ( ((v) >= 'A') && ((v) <= 'Z') )
 Determine if octet is ascii uppercase character. More...
 
#define afw_ascii_is_alpha(v)    ( afw_ascii_is_ascii_lowercase(v) || afw_ascii_is_ascii_uppercase(v) )
 Determine if octet is ascii alpha character. More...
 
#define afw_ascii_is_alphanumeric(v)    ( afw_ascii_is_ascii_alpha(v) || ( ((v)>='0') && ((v)<='9') ) )
 Determine if octet is ascii digit character. More...
 
#define afw_ascii_is_control_character(v)    ( ((v) <= 31) || ((v) == AFW_ASCII_DELETE) )
 Determine if octet is ascii control character. More...
 
#define afw_ascii_is_digit(v)    ( ((v)>='0') && ((v)<='9') )
 Determine if octet is digit character. More...
 
#define afw_ascii_is_hex_digit(v)    ( afw_ascii_decode_hex_digit(v) != -1 )
 Determine if octet is ascii hex digit. More...
 
#define afw_ascii_is_whitespace(v)    ((v) == 32 || ((v) >= 9 && (v) <= 13))
 Determine if octet is white space. More...
 

Functions

 afw_ascii_decode_hex_digit (afw_octet_t octet)
 Decode ascii hex digit. More...
 
 afw_ascii_encode_hex_digit (afw_octet_t octet)
 Encode ascii hex digit. More...
 

Detailed Description

ASC-II

Macro Definition Documentation

◆ afw_ascii_is_alpha

#define afw_ascii_is_alpha (   v)     ( afw_ascii_is_ascii_lowercase(v) || afw_ascii_is_ascii_uppercase(v) )

Determine if octet is ascii alpha character.

Parameters
vis octet to test.
Returns
result of test.

Definition at line 172 of file afw_ascii.h.

◆ afw_ascii_is_alphanumeric

#define afw_ascii_is_alphanumeric (   v)     ( afw_ascii_is_ascii_alpha(v) || ( ((v)>='0') && ((v)<='9') ) )

Determine if octet is ascii digit character.

Parameters
vis octet to test.
Returns
result of test.

Definition at line 181 of file afw_ascii.h.

◆ afw_ascii_is_control_character

#define afw_ascii_is_control_character (   v)     ( ((v) <= 31) || ((v) == AFW_ASCII_DELETE) )

Determine if octet is ascii control character.

Parameters
vis octet to test.
Returns
result of test.

Definition at line 190 of file afw_ascii.h.

◆ afw_ascii_is_digit

#define afw_ascii_is_digit (   v)     ( ((v)>='0') && ((v)<='9') )

Determine if octet is digit character.

Parameters
vis octet to test.
Returns
result of test.

Definition at line 199 of file afw_ascii.h.

◆ afw_ascii_is_hex_digit

#define afw_ascii_is_hex_digit (   v)     ( afw_ascii_decode_hex_digit(v) != -1 )

Determine if octet is ascii hex digit.

Parameters
vis octet to test.
Returns
result of test.

Definition at line 219 of file afw_ascii.h.

◆ afw_ascii_is_lowercase

#define afw_ascii_is_lowercase (   v)     ( ((v) >= 'a') && ((v) <= 'z') )

Determine if octet is ascii lowercase character.

Parameters
vis octet to test.
Returns
result of test.

Definition at line 154 of file afw_ascii.h.

◆ afw_ascii_is_printable

#define afw_ascii_is_printable (   v)     ( ((v)>=AFW_ASCII_SPACE) && ((v)<=AFW_ASCII_TILDE) )

Determine if octet is ascii printable character.

Parameters
vis octet to test.
Returns
result of test.

Definition at line 145 of file afw_ascii.h.

◆ afw_ascii_is_uppercase

#define afw_ascii_is_uppercase (   v)     ( ((v) >= 'A') && ((v) <= 'Z') )

Determine if octet is ascii uppercase character.

Parameters
vis octet to test.
Returns
result of test.

Definition at line 163 of file afw_ascii.h.

◆ afw_ascii_is_whitespace

#define afw_ascii_is_whitespace (   v)     ((v) == 32 || ((v) >= 9 && (v) <= 13))

Determine if octet is white space.

Parameters
vis octet to test.
Returns
result of test.

Definition at line 238 of file afw_ascii.h.

Function Documentation

◆ afw_ascii_decode_hex_digit()

afw_ascii_decode_hex_digit ( afw_octet_t  octet)

Decode ascii hex digit.

Parameters
octetcontain ascii hex digit.
Returns
octet containing binary value of hex digit or -1 if error.

Definition at line 31 of file afw_ascii.c.

◆ afw_ascii_encode_hex_digit()

afw_ascii_encode_hex_digit ( afw_octet_t  octet)

Encode ascii hex digit.

Parameters
octetcontaining binary value 0 through 15.
Returns
octet containing ascii encoded hex digit or -1 if error.

Definition at line 39 of file afw_ascii.c.