<htmllang="en-US"><head><title>4coder API Docs</title><style>body{background:#FAFAFA;color:#0D0D0D;}h1,h2,h3,h4{color:#309030;margin:0;}h2{margin-top:6mm;}h3{margin-top:5mm;margin-bottom:5mm;}h4{font-size:1.1em;}a{color:#309030;text-decoration:none;}a:visited{color:#A0C050;}a:hover{background:#E0FFD0;}ul{list-style:none;padding:0;margin:0;}</style></head>
<h2id='section_introduction'>§1 Introduction</h2><div><p>This is the documentation for alpha 4.0.11 The documentation is still under construction so some of the links are linking to sections that have not been written yet. What is here should be correct and I suspect useful even without some of the other sections.</p><p>If you have questions or discover errors please contact <spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'>editor@4coder.net</span> or to get help from community members you can post on the 4coder forums hosted on handmade.network at <spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'>4coder.handmade.network</span></p></div>
<h2id='section_types_and_functions'>§3 Types and Functions</h2><h3>§3.1 Function List</h3><ul><li><ahref='#exec_command_doc'>exec_command</a></li><li><ahref='#exec_system_command_doc'>exec_system_command</a></li><li><ahref='#clipboard_post_doc'>clipboard_post</a></li><li><ahref='#clipboard_count_doc'>clipboard_count</a></li><li><ahref='#clipboard_index_doc'>clipboard_index</a></li><li><ahref='#get_buffer_count_doc'>get_buffer_count</a></li><li><ahref='#get_buffer_first_doc'>get_buffer_first</a></li><li><ahref='#get_buffer_next_doc'>get_buffer_next</a></li><li><ahref='#get_buffer_doc'>get_buffer</a></li><li><ahref='#get_buffer_by_name_doc'>get_buffer_by_name</a></li><li><ahref='#buffer_read_range_doc'>buffer_read_range</a></li><li><ahref='#buffer_replace_range_doc'>buffer_replace_range</a></li><li><ahref='#buffer_compute_cursor_doc'>buffer_compute_cursor</a></li><li><ahref='#buffer_batch_edit_doc'>buffer_batch_edit</a></li><li><ahref='#buffer_set_setting_doc'>buffer_set_setting</a></li><li><ahref='#buffer_token_count_doc'>buffer_token_count</a></li><li><ahref='#buffer_read_tokens_doc'>buffer_read_tokens</a></li><li><ahref='#buffer_get_token_index_doc'>buffer_get_token_index</a></li><li><ahref='#create_buffer_doc'>create_buffer</a></li><li><ahref='#save_buffer_doc'>save_buffer</a></li><li><ahref='#kill_buffer_doc'>kill_buffer</a></li><li><ahref='#get_view_first_doc'>get_view_first</a></li><li><ahref='#get_view_next_doc'>get_view_next</a></li><li><ahref='#get_view_doc'>get_view</a></li><li><ahref='#get_active_view_doc'>get_active_view</a></li><li><ahref='#open_view_doc'>open_view</a></li><li><ahref='#close_view_doc'>close_view</a></li><li><ahref='#set_active_view_doc'>set_active_view</a></li><li><ahref='#view_set_setting_doc'>view_set_setting</a></li><li><ahref='#view_set_split_proportion_doc'>view_set_split_proportion</a></li><li><ahref='#view_compute_cursor_doc'>view_compute_cursor</a></li><li><ahref='#view_set_cursor_doc'>view_set_cursor</a></li><li><ahref='#view_set_scroll_doc'>view_set_scroll</a></li><li><ahref='#view_set_mark_doc'>view_set_mark</a></li><li><ahref='#view_set_highlight_doc'>view_set_highlight</a></li><li><ahref='#view_set_buffer_doc'>view_set_buffer</a></li><li><ahref='#view_post_fade_doc'>view_post_fade</a></li><li><ahref='#get_user_input_doc'>get_user_input</a></li><li><ahref='#get_command_input_doc'>get_command_input</a></li><li><ahref='#get_mouse_state_doc'>get_mouse_state</a></li><li><ahref='#start_query_bar_doc'>start_query_bar</a></li><li><ahref='#end_query_bar_doc'>end_query_bar</a></li><li><ahref='#print_message_doc'>print_message</a></li><li><ahref='#change_theme_doc'>change_theme</a></li><li><ahref='#change_font_doc'>change_font</a></li><li><ahref='#buffer_set_font_doc'>buffer_set_font</a></li><li><ahref='#set_theme_colors_doc'>set_theme_colors</a></li><li><ahref='#get_theme_colors_doc'>get_theme_colors</a></li><li><ahref='#directory_get_hot_doc'>directory_get_hot</a></li><li><ahref='#get_file_list_doc'>get_file_list</a></li><li><ahref='#free_file_list_doc'>free_file_list</a></li><li><ahref='#memory_allocate_doc'>memory_allocate</a></li><li><ahref='#memory_set_protection_doc'>memory_set_protection</a></li><li><ahref='#memory_free_doc'>memory_free</a></li><li><ahref='#file_exists_doc'>file_exists</a></li><li><ahref='#directory_cd_doc'>directory_cd</a></li><li><ahref='#get_4ed_path_doc'>get_4ed_path</a></li><li><ahref='#show_mouse_cursor_doc'>show_mouse_cursor</a></li><li><ahref='#toggle_fullscreen_doc'>toggle_fullscreen</a></li><li><ahref='#is_fullscreen_doc'>is_fullscreen</a></li><li><ahref='#send_exit_signal_doc'>send_exit_signal</a></li></ul><h3>§3.2 Type List</h3><ul><li><ahref='#bool32_doc'>bool32</a></li><li><ahref='#int_color_doc'>int_color</a></li><li><ahref='#Key_Code_doc'>Key_Code</a></li><li><ahref='#Buffer_ID_doc'>Buffer_ID</a></li><li><ahref='#View_ID_doc'>View_ID</a></li><li><ahref='#Key_Modifier_doc'>Key_Modifier</a></li><li><ahref='#Key_Modifier_Flag_doc'>Key_Modifier_Flag</a></li><li><ahref='
See Buffer_Identifier for information on how this type specifies a buffer.</div></div></div><div><divstyle='font-weight: 600;'>path</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The path parameter specifies the path in which the command shall be executed. The string need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>path_len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The parameter path_len specifies the length of the path string.</div></div></div><div><divstyle='font-weight: 600;'>command</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The command parameter specifies the command that shall be executed. The string need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>command_len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The parameter command_len specifies the length of the command string.</div></div></div><div><divstyle='font-weight: 600;'>flags</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Flags for the behavior of the call are specified in the flags parameter.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A call to exec_system_command executes a command as if called from the command line, and sends the output to
a buffer. The buffer identifier can either name a new buffer that does not exist, name a buffer that does
exist, or provide the id of a buffer that does exist.<br><br>
If the buffer is not already in an open view and the view parameter is not NULL,
then the provided view will display the output buffer.<br><br>
If the view parameter is NULL, no view will switch to the output.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Identifier_doc'>Buffer_Identifier</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Command_Line_Input_Flag_doc'>Command_Line_Input_Flag</a></div></div><hr><divid='clipboard_post_doc'style='margin-bottom: 1cm;'><h4>§3.3.3: clipboard_post</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->clipboard_post(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>int32_t clipboard_id,<br>char *str,<br>int32_t len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>clipboard_id</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter is set up to prepare for future features, it should always be 0 for now.</div></div></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter specifies the string to be posted to the clipboard, it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The len parameter specifies the length of the str string.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Stores the string str in the clipboard initially with index 0.
Also reports the copy to the operating system, so that it may
be pasted into other applications.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#The_4coder_Clipboard_doc'>The_4coder_Clipboard</a></div></div><hr><divid='clipboard_count_doc'style='margin-bottom: 1cm;'><h4>§3.3.4: clipboard_count</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t app->clipboard_count(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>int32_t clipboard_id<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>clipboard_id</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter is set up to prepare for future features, it should always be 0 for now.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of items in the clipboard.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#The_4coder_Clipboard_doc'>The_4coder_Clipboard</a></div></div><hr><divid='clipboard_index_doc'style='margin-bottom: 1cm;'><h4>§3.3.5: clipboard_index</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t app->clipboard_index(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>int32_t clipboard_id,<br>int32_t item_index,<br>char *out,<br>int32_t len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>clipboard_id</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter is set up to prepare for future features, it should always be 0 for now.</div></div></div><div><divstyle='font-weight: 600;'>item_index</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies which item to read, 0 is the most recent copy, 1 is the second most recent copy, etc.</div></div></div><div><divstyle='font-weight: 600;'>out</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter provides a buffer where the clipboard contents are written. This parameter may be NULL.</div></div></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the out buffer.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the size of the item associated with item_index.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This function always returns the size of the item even if the output buffer is NULL.
If the output buffer is too small to contain the whole string, it is filled with the
first len character of the clipboard contents. The output string is not null terminated.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#The_4coder_Clipboard_doc'>The_4coder_Clipboard</a></div></div><hr><divid='get_buffer_count_doc'style='margin-bottom: 1cm;'><h4>§3.3.6: get_buffer_count</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t app->get_buffer_count(<divstyle='margin-left: 4mm;'>Application_Links *app<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>TODO<br><br></div></div><hr><divid='get_buffer_first_doc'style='margin-bottom: 1cm;'><h4>§3.3.7: get_buffer_first</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>Buffer_Summary app->get_buffer_first(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>access</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the summary of the first buffer in a buffer loop.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call begins a loop across all the buffers.<br><br>
If the buffer returned does not exist, the loop is finished.
Buffers should not be killed durring a buffer loop.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Summary_doc'>Buffer_Summary</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Access_Flag_doc'>Access_Flag</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#get_buffer_next_doc'>get_buffer_next</a></div></div><hr><divid='get_buffer_next_doc'style='margin-bottom: 1cm;'><h4>§3.3.8: get_buffer_next</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->get_buffer_next(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>Access_Flag access<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The Buffer_Summary pointed to by buffer is iterated to the next buffer or to a null summary if this is the last buffer.</div></div></div><div><divstyle='font-weight: 600;'>access</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access. The buffer outputted will be the next buffer that is accessible.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call steps a Buffer_Summary to the next buffer in the global buffer order.
The global buffer order is kept roughly in the order of most recently used to least recently used.<br><br>
If the buffer outputted does not exist, the loop is finished.
or if the read range is not within the bounds of the buffer.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr><divid='buffer_replace_range_doc'style='margin-bottom: 1cm;'><h4>§3.3.12: buffer_replace_range</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->buffer_replace_range(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>int32_t start,<br>int32_t end,<br>char *str,<br>int32_t len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the buffer to edit.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies absolute position of the first character in the replace range.</div></div></div><div><divstyle='font-weight: 600;'>end</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the absolute position of the the character one past the end of the replace range.</div></div></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the the string to write into the range; it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the str string.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the replacement succeeds.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this call succeeds it deletes the range from start to end
range is not within the bounds of the buffer.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr><divid='buffer_compute_cursor_doc'style='margin-bottom: 1cm;'><h4>§3.3.13: buffer_compute_cursor</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->buffer_compute_cursor(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>Buffer_Seek seek,<br>Partial_Cursor *cursor_out<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The buffer parameter specifies the buffer on which to run the cursor computation.</div></div></div><div><divstyle='font-weight: 600;'>seek</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The seek parameter specifies the target position for the seek.</div></div></div><div><divstyle='font-weight: 600;'>cursor_out</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>On success this struct is filled with the result of the seek.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success. This call can fail if the buffer summary provided
does not summarize an actual buffer in 4coder, or if the provided seek format is invalid. The valid
seek types are seek_pos and seek_line_char.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Computes a Partial_Cursor for the given seek position with no side effects.
types are absolute position and line,column position.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Seek_doc'>Buffer_Seek</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Partial_Cursor_doc'>Partial_Cursor</a></div></div><hr><divid='buffer_batch_edit_doc'style='margin-bottom: 1cm;'><h4>§3.3.14: buffer_batch_edit</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->buffer_batch_edit(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>char *str,<br>int32_t str_len,<br>Buffer_Edit *edits,<br>int32_t edit_count,<br>Buffer_Batch_Edit_Type type<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter provides all of the source string for the edits in the batch.</div></div></div><div><divstyle='font-weight: 600;'>str_len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the str string.</div></div></div><div><divstyle='font-weight: 600;'>edits</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter provides about the source string and destination range of each edit as an array.</div></div></div><div><divstyle='font-weight: 600;'>edit_count</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the number of Buffer_Edit structs in edits.</div></div></div><div><divstyle='font-weight: 600;'>type</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This prameter specifies what type of batch edit to execute.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the batch edit succeeds. This call can fail if the provided
buffer summary does not refer to an actual buffer in 4coder.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>TODO<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Edit_doc'>Buffer_Edit</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Batch_Edit_Type_doc'>Buffer_Batch_Edit_Type</a></div></div><hr><divid='buffer_set_setting_doc'style='margin-bottom: 1cm;'><h4>§3.3.15: buffer_set_setting</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->buffer_set_setting(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>Buffer_Setting_ID setting,<br>int32_t value<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The buffer parameter specifies the buffer on which to set a setting.</div></div></div><div><divstyle='font-weight: 600;'>setting</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The setting parameter identifies the setting that shall be changed.</div></div></div><div><divstyle='font-weight: 600;'>value</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The value parameter specifies the value to which the setting shall be changed.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Setting_ID_doc'>Buffer_Setting_ID</a></div></div><hr><divid='buffer_token_count_doc'style='margin-bottom: 1cm;'><h4>§3.3.16: buffer_token_count</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t app->buffer_token_count(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Specifies the buffer from which to read the token count.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>If tokens are available for the buffer, the number of tokens on the buffer is returned.
If the buffer does not exist or if it is not a lexed buffer, the return is zero.</div></div><hr><divid='buffer_read_tokens_doc'style='margin-bottom: 1cm;'><h4>§3.3.17: buffer_read_tokens</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->buffer_read_tokens(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>int32_t start_token,<br>int32_t end_token,<br>Cpp_Token *tokens_out<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Specifies the buffer from which to read tokens.</div></div></div><div><divstyle='font-weight: 600;'>first_token</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Specifies the index of the first token to read.</div></div></div><div><divstyle='font-weight: 600;'>end_token</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Specifies the token to stop reading at.</div></div></div><div><divstyle='font-weight: 600;'>tokens_out</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The memory that will store the tokens read from the buffer.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Returns non-zero on success. This call can fail if the buffer doesn't
exist or doesn't have tokens ready, or if either the first or last index is out of bounds.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Puts the data for the tokens with the indices [first_token,last_token<br><br></div></div><hr><divid='buffer_get_token_index_doc'style='margin-bottom: 1cm;'><h4>§3.3.18: buffer_get_token_index</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->buffer_get_token_index(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>int32_t pos,<br>Cpp_Get_Token_Result *get_result<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The buffer from which to get a token.</div></div></div><div><divstyle='font-weight: 600;'>pos</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The position in the buffer in absolute coordinates.</div></div></div><div><divstyle='font-weight: 600;'>get_result</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The output struct specifying which token contains pos.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Returns non-zero on success. This call can fail if the buffer doesn't exist,
or if the buffer doesn't have tokens ready.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call finds the token that contains a particular position, or if the position is in between
tokens it finds the index of the token to the left of the position.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Cpp_Get_Token_Result_doc'>Cpp_Get_Token_Result</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#cpp_get_token_doc'>cpp_get_token</a></div></div><hr><divid='create_buffer_doc'style='margin-bottom: 1cm;'><h4>§3.3.19: create_buffer</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>Buffer_Summary app->create_buffer(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>char *filename,<br>int32_t filename_len,<br>Buffer_Create_Flag flags<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>filename</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The filename parameter specifies the name of the file to be opened or created;
it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>filename_len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The filename_len parameter spcifies the length of the filename string.</div></div></div><div><divstyle='font-weight: 600;'>flags</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The flags parameter specifies behaviors for buffer creation.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the summary of the created buffer.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Tries to create a new buffer and associate it to the given filename. If such a buffer
already exists the existing buffer is returned in the Buffer_Summary and no new buffer is
created. If the buffer does not exist a new buffer is created and named after the given
filename. If the filename corresponds to a file on the disk that file is loaded and put into
buffer, if the filename does not correspond to a file on disk the buffer is created empty.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Summary_doc'>Buffer_Summary</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Create_Flag_doc'>Buffer_Create_Flag</a></div></div><hr><divid='save_buffer_doc'style='margin-bottom: 1cm;'><h4>§3.3.20: save_buffer</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->save_buffer(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>char *filename,<br>int32_t filename_len,<br>uint32_t flags<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The buffer parameter specifies the buffer to save to a file.</div></div></div><div><divstyle='font-weight: 600;'>filename</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The filename parameter specifies the name of the file to associated to the buffer; it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>filename_len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The filename_len parameter specifies the length of the filename string.</div></div></div><div><divstyle='font-weight: 600;'>flags</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter is not currently used and should be set to 0 for now.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div></div><hr><divid='kill_buffer_doc'style='margin-bottom: 1cm;'><h4>§3.3.21: kill_buffer</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->kill_buffer(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Identifier buffer,<br>View_ID view_id,<br>Buffer_Kill_Flag flags<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The buffer parameter specifies the buffer to try to kill.</div></div></div><div><divstyle='font-weight: 600;'>view_id</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The view_id parameter specifies the view that will contain the "are you sure" dialogue if the buffer is dirty.</div></div></div><div><divstyle='font-weight: 600;'>flags</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The flags parameter specifies behaviors for the buffer kill.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the buffer is killed.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Tries to kill the idenfied buffer. If the buffer is dirty and the "are you sure"
If the view is not open the kill fails.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Kill_Flag_doc'>Buffer_Kill_Flag</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Identifier_doc'>Buffer_Identifier</a></div></div><hr><divid='get_view_first_doc'style='margin-bottom: 1cm;'><h4>§3.3.22: get_view_first</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>View_Summary app->get_view_first(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>access</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the summary of the first view in a view loop.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call begins a loop across all the open views.<br><br>
Views should not be closed or opened durring a view loop.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Access_Flag_doc'>Access_Flag</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#get_view_next_doc'>get_view_next</a></div></div><hr><divid='get_view_next_doc'style='margin-bottom: 1cm;'><h4>§3.3.23: get_view_next</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->get_view_next(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Access_Flag access<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>view</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The View_Summary pointed to by view is iterated to the next view or to a null summary if this is the last view.</div></div></div><div><divstyle='font-weight: 600;'>access</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access. The view outputted will be the next view that is accessible.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call steps a View_Summary to the next view in the global view order.<br><br>
returns a null summary.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>4coder is built with a limit of 16 views. If 16 views are already open when this is called the
in the system, the call will fail.<br><br></div></div><hr><divid='set_active_view_doc'style='margin-bottom: 1cm;'><h4>§3.3.28: set_active_view</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->set_active_view(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>view</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies which view to make active.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>If the given view is open, it is set as the
and the turn_on set to false, will switch back to showing the cursor.<br><br></div></div><hr><divid='view_set_buffer_doc'style='margin-bottom: 1cm;'><h4>§3.3.36: view_set_buffer</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_set_buffer(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_ID buffer_id,<br>Set_Buffer_Flag flags<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>view</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies the view in which to display the buffer.</div></div></div><div><divstyle='font-weight: 600;'>buffer_id</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The buffer_id parameter specifies which buffer to show in the view.</div></div></div><div><divstyle='font-weight: 600;'>flags</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The flags parameter specifies behaviors for setting the buffer.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>On success view_set_buffer sets the specified view's current buffer and
cancels and dialogue shown in the view and displays the file.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Set_Buffer_Flag_doc'>Set_Buffer_Flag</a></div></div><hr><divid='view_post_fade_doc'style='margin-bottom: 1cm;'><h4>§3.3.37: view_post_fade</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_post_fade(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>float seconds,<br>int32_t start,<br>int32_t end,<br>int_color color<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>view</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies the view onto which the fade effect shall be posted.</div></div></div><div><divstyle='font-weight: 600;'>seconds</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the number of seconds the fade effect should last.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the absolute position of the first character of the fade range.</div></div></div><div><divstyle='font-weight: 600;'>end</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the absolute position of the character one past the end of the fdae range.</div></div></div><div><divstyle='font-weight: 600;'>color</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The color parameter specifies the initial color of the text before it fades to it's natural color.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#int_color_doc'>int_color</a></div></div><hr><divid='get_user_input_doc'style='margin-bottom: 1cm;'><h4>§3.3.38: get_user_input</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>User_Input app->get_user_input(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Input_Type_Flag get_type,<br>Input_Type_Flag abort_type<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>get_type</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The get_type parameter specifies the set of input types that should be returned.</div></div></div><div><divstyle='font-weight: 600;'>abort_type</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The get_type parameter specifies the set of input types that should trigger an abort signal.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns a User_Input that describes a user input event.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call preempts the command. The command is resumed if either a get or abort condition
until end_query_bar or the end of the command. It is commonly a good idea to make
this a pointer to a Query_Bar stored on the stack.</div></div></div><div><divstyle='font-weight: 600;'>flags</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter is not currently used and should be 0 for now.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call tells the active view to begin displaying a "Query_Bar" which is a small
GUI element that can overlap a buffer or other 4coder GUI. The contents of the bar
can be changed after the call to start_query_bar and the query bar shown by 4coder
will reflect the change. Since the bar stops showing when the command exits the
only use for this call is in an interactive command that makes calls to get_user_input.<br><br></div></div><hr><divid='end_query_bar_doc'style='margin-bottom: 1cm;'><h4>§3.3.42: end_query_bar</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->end_query_bar(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Query_Bar *bar,<br>uint32_t flags<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>bar</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter should be a bar pointer of a currently active query bar.</div></div></div><div><divstyle='font-weight: 600;'>flags</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter is not currently used and should be 0 for now.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Stops showing the particular query bar specified by the bar parameter.<br><br></div></div><hr><divid='print_message_doc'style='margin-bottom: 1cm;'><h4>§3.3.43: print_message</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->print_message(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>char *str,<br>int32_t len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter specifies the string to post to *messages*; it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The len parameter specifies the length of the str string.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call posts a string to the *messages* buffer.<br><br></div></div><hr><divid='change_theme_doc'style='margin-bottom: 1cm;'><h4>§3.3.44: change_theme</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->change_theme(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>name</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The name parameter specifies the name of the theme to begin using; it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The len parameter specifies the length of the name string.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call changes 4coder's color pallet to one of the built in themes.<br><br></div></div><hr><divid='change_font_doc'style='margin-bottom: 1cm;'><h4>§3.3.45: change_font</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->change_font(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len,<br>bool32 apply_to_all_files<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></d
durring the start hook because several files already exist at that time.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call changes 4coder's default font to one of the built in fonts.<br><br></div></div><hr><divid='buffer_set_font_doc'style='margin-bottom: 1cm;'><h4>§3.3.46: buffer_set_font</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->buffer_set_font(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>char *name,<br>int32_t len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter the buffer that shall have it's font changed</div></div></div><div><divstyle='font-weight: 600;'>name</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The name parameter specifies the name of the font to begin using; it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The len parameter specifies the length of the name string.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call sets the display font of a particular buffer.<br><br></div></div><hr><divid='set_theme_colors_doc'style='margin-bottom: 1cm;'><h4>§3.3.47: set_theme_colors</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->set_theme_colors(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Theme_Color *colors,<br>int32_t count<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>colors</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The colors pointer provides an array of color structs pairing differet style tags to color codes.</div></div></div><div><divstyle='font-weight: 600;'>count</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The count parameter specifies the number of Theme_Color structs in the colors array.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>For each struct in the array, the slot in the main color pallet specified by the
no change is made to the color pallet.<br><br></div></div><hr><divid='get_theme_colors_doc'style='margin-bottom: 1cm;'><h4>§3.3.48: get_theme_colors</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->get_theme_colors(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>Theme_Color *colors,<br>int32_t count<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>colors</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>an array of color structs listing style tags to get color values for</div></div></div><div><divstyle='font-weight: 600;'>count</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>the number of color structs in the colors array</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>For each struct in the array, the color field of the struct is filled with the
value is invalid the color is filled with black.<br><br></div></div><hr><divid='directory_get_hot_doc'style='margin-bottom: 1cm;'><h4>§3.3.49: directory_get_hot</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t app->directory_get_hot(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>char *out,<br>int32_t capacity<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>out</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter provides a character buffer that receives the 4coder 'hot directory'.</div></div></div><div><divstyle='font-weight: 600;'>capacity</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the maximum size to be output to the out buffer.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the size of the string written into the buffer.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>4coder has a concept of a 'hot directory' which is the directory most recently
directories controlled on the custom side.<br><br></div></div><hr><divid='get_file_list_doc'style='margin-bottom: 1cm;'><h4>§3.3.50: get_file_list</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>File_List app->get_file_list(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>char *dir,<br>int32_t len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>dir</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the directory whose files will be enumerated in the returned list; it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter the length of the dir string.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns a File_List struct containing pointers to the names of the files in
when it is no longer in use.</div></div><hr><divid='free_file_list_doc'style='margin-bottom: 1cm;'><h4>§3.3.51: free_file_list</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->free_file_list(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>File_List list<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>list</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter provides the file list to be freed.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>After this call the file list passed in should not be read or written to.<br><br></div></div><hr><divid='memory_allocate_doc'style='margin-bottom: 1cm;'><h4>§3.3.52: memory_allocate</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void* app->memory_allocate(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>int32_t size<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>size</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The size in bytes of the block that should be returned.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This calls to a low level OS allocator which means it is best used
if it will be freed or if it's mem protection status will be changed.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#memory_free_doc'>memory_free</a></div></div><hr><divid='memory_set_protection_doc'style='margin-bottom: 1cm;'><h4>§3.3.53: memory_set_protection</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->memory_set_protection(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>void *ptr,<br>int32_t size,<br>Memory_Protect_Flags flags<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>ptr</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The base of the block on which to set memory protection flags.</div></div></div><div><divstyle='font-weight: 600;'>size</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The size that was originally used to allocate this block.</div></div></div><div><divstyle='font-weight: 600;'>flags</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The new memory protection flags.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call sets the memory protection flags of a block of memory that was previously
allocate by memory_allocate.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#memory_allocate_doc'>memory_allocate</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Memory_Protect_Flags_doc'>Memory_Protect_Flags</a></div></div><hr><divid='memory_free_doc'style='margin-bottom: 1cm;'><h4>§3.3.54: memory_free</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->memory_free(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>void *ptr,<br>int32_t size<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>mem</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The base of a block to free.</div></div></div><div><divstyle='font-weight: 600;'>size</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The size that was originally used to allocate this block.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call frees a block of memory that was previously allocated by
memory_allocate.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#memory_allocate_doc'>memory_allocate</a></div></div><hr><divid='file_exists_doc'style='margin-bottom: 1cm;'><h4>§3.3.55: file_exists</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->file_exists(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>char *filename,<br>int32_t len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>filename</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the full path to a file; it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the filename string.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if and only if the file exists.</div></div><hr><divid='directory_cd_doc'style='margin-bottom: 1cm;'><h4>§3.3.56: directory_cd</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->directory_cd(<divstyle='margin-left: 4mm;'>Application_Links *app,<br>char *dir,<br>int32_t *len,<br>int32_t capacity,<br>char *rel_path,<br>int32_t rel_len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>dir</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter provides a character buffer that stores a directory; it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the dir string.</div></div></div><div><divstyle='font-weight: 600;'>capacity</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the maximum size of the dir string.</div></div></div><div><divstyle='font-weight: 600;'>rel_path</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the path to change to, may include '.' or '..'; it need not be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>rel_len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the rel_path string.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the call succeeds.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call succeeds if the new directory exists and the it fits inside the
Stream mode can be enabled with -S or -F flags on the command line to 4ed.<br><br></div></div><hr><divid='is_fullscreen_doc'style='margin-bottom: 1cm;'><h4>§3.3.60: is_fullscreen</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->is_fullscreen(<divstyle='margin-left: 4mm;'>Application_Links *app<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns true if the 4coder is in full screen mode. This call
frame if the state is not changed.<br><br></div></div><hr><divid='send_exit_signal_doc'style='margin-bottom: 1cm;'><h4>§3.3.61: send_exit_signal</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->send_exit_signal(<divstyle='margin-left: 4mm;'>Application_Links *app<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call sends a signal to 4coder to attempt to exit. If there are unsaved
files this triggers a dialogue ensuring you're okay with closing.<br><br></div></div><hr><h3>§3.4 Type Descriptions</h3><divid='bool32_doc'style='margin-bottom: 1cm;'><h4>§3.4.1: bool32</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>typedef int32_t bool32;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>bool32 is an alias name to signal that an integer parameter or field is for
true/false vales.<br><br></div></div><hr><divid='int_color_doc'style='margin-bottom: 1cm;'><h4>§3.4.2: int_color</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>typedef uint32_t int_color;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>int_color is an alias name to signal that an integer parameter or field is for
a color value, colors are specified as 24 bit integers in 3 channels: 0xRRGGBB.<br><br></div></div><hr><divid='Key_Code_doc'style='margin-bottom: 1cm;'><h4>§3.4.3: Key_Code</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>typedef unsigned char Key_Code;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Key_Code is the alias for key codes including raw codes and codes translated
to textual input that takes modifiers into account.<br><br></div></div><hr><divid='Buffer_ID_doc'style='margin-bottom: 1cm;'><h4>§3.4.4: Buffer_ID</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>typedef int32_t Buffer_ID;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Buffer_ID is used to name a 4coder buffer. Each buffer has a unique id but
when a buffer is closed it's id may be recycled by future, different buffers.<br><br></div></div><hr><divid='View_ID_doc'style='margin-bottom: 1cm;'><h4>§3.4.5: View_ID</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>typedef int32_t View_ID;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>View_ID is used to name a 4coder view. Each view has a unique id in
the interval [1,16].<br><br></div></div><hr><divid='Key_Modifier_doc'style='margin-bottom: 1cm;'><h4>§3.4.6: Key_Modifier</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Key_Modifier;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A Key_Modifier acts as an index for specifying modifiers in arrays.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>MDFR_SHIFT_INDEX</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>MDFR_CONTROL_INDEX</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>MDFR_ALT_INDEX</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>MDFR_CAPS_INDEX</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>MDFR_HOLD_INDEX</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>MDFR_INDEX_COUNT</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>MDFR_INDEX_COUNT is used to specify the number of modifiers supported.<br><br></div></div></div></div><hr><divid='Key_Modifier_Flag_doc'style='margin-bottom: 1cm;'><h4>§3.4.7: Key_Modifier_Flag</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Key_Modifier_Flag;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A Key_Modifier_Flag field is used to specify a specific state of modifiers.
from with the buffer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BufferSetting_WrapLine</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The BufferSetting_WrapLine setting is used to determine whether a buffer prefers
to be viewed with wrapped lines, individual views can be set to override this value after
being tied to the buffer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BufferSetting_MapID</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The BufferSetting_MapID setting specifies the id of the command map that should be
active when a buffer is active.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BufferSetting_Eol</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The BufferSetting_Eol setting specifies how line ends should be saved to the backing file.
A 1 indicates dos endings "\r\n" and a 0 indicates nix endings "\n".<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BufferSetting_Unimportant</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The BufferSetting_Unimportant setting marks a buffer so that it's dirty state will be completely
ignored. This means the "dirty" star is hidden and the buffer can be closed without presenting an
"are you sure" dialogue screen.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BufferSetting_ReadOnly</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The BufferSetting_ReadOnly setting marks a buffer so that it can only be returned from buffer
at the border of the panel for long lines. Whenever the view switches to a new buffer it
will reset this setting to match the 'preferred' line wrapping setting of the buffer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>ViewSetting_ShowWhitespace</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The ViewSetting_ShowWhitespace setting determines whether the view highlights
whitespace in a file. Whenever the view switches to a new buffer this setting is turned off.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>ViewSetting_ShowScrollbar</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The ViewSetting_ShowScrollbar setting determines whether a scroll bar is
cleared to empty even if it's associated file already has content.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BufferCreate_NeverNew</span> = 0x4</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>When BufferCreate_NeverNew is set it indicates that the buffer should
without asking, even when the buffer is dirty.<br><br></div></div></div></div><hr><divid='Access_Flag_doc'style='margin-bottom: 1cm;'><h4>§3.4.16: Access_Flag</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Access_Flag;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>An Access_Flag field specifies what sort of permission you grant to an
access call. An access call is usually one the returns a summary struct. If a
4coder object has a particular protection flag set and the corresponding bit is
not set in the access field, that 4coder object is hidden. On the other hand if
a protection flag is set in the access parameter and the object does not have
that protection flag, the object is still returned from the access call.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>AccessOpen</span> = 0x0</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>AccessOpen does not include any bits, it indicates that the access should
only return objects that have no protection flags set.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>AccessProtected</span> = 0x1</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>AccessProtected is set on buffers and views that are "read only" such as
the output from an app->exec_system_command call such as *build*. This is to prevent
the user from accidentally editing output that they might prefer to keep in tact.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>AccessHidden</span> = 0x2</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>AccessHidden is set on any view that is not currently showing it's file, for
instance because it is navigating the file system to open a file.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>AccessAll</span> = 0xFF</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>AccessAll is a catchall access for cases where an access call should always
to it's file or loading the buffer from the file both act as sync points.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>DirtyState_UpToDate</span> = 0</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>DirtyState_UpToDate indicates that there are no unsaved changes and
the underlying system file still agrees with the buffer's state.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>DirtyState_UnsavedChanges</span> = 1</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>DirtyState_UnsavedChanges indicates that there have been changes in the
buffer since the last sync point.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>DirtyState_UnloadedChanges</span> = 2</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>DirtyState_UnsavedChanges indicates that the underlying file has been
edited since the last sync point with the buffer.<br><br></div></div></div></div><hr><divid='Seek_Boundary_Flag_doc'style='margin-bottom: 1cm;'><h4>§3.4.18: Seek_Boundary_Flag</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Seek_Boundary_Flag;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A Seek_Boundary_Flag field specifies a set of "boundary" types used in seeks for the
beginning or end of different types of words.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BoundaryWhitespace</span> = 0x1</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BoundaryToken</span> = 0x2</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BoundaryAlphanumeric</span> = 0x4</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BoundaryCamelCase</span> = 0x8</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div></div><hr><divid='Command_Line_Interface_Flag_doc'style='margin-bottom: 1cm;'><h4>§3.4.19: Command_Line_Interface_Flag</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Command_Line_Interface_Flag;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A Command_Line_Interface_Flag field specifies the behavior of a call to a command line interface.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CLI_OverlapWithConflict</span> = 0x1</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If CLI_OverlapWithConflict is set if output buffer of the new command is already
in use by another command which is still executing, the older command relinquishes control
of the buffer and both operate simultaneously with only the newer command outputting to
the buffer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CLI_AlwaysBindToView</span> = 0x2</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If CLI_AlwaysBindToView is set the output buffer will always be set in the active
view even if it is already set in another open view.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CLI_CursorAtEnd</span> = 0x4</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If CLI_CursorAtEnd is set the cursor will be kept at the end of the output buffer,
otherwise the cursor is kept at the beginning.<br><br></div></div></div></div><hr><divid='Auto_Indent_Flag_doc'style='margin-bottom: 1cm;'><h4>§3.4.20: Auto_Indent_Flag</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Auto_Indent_Flag;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>An Auto_Indent_Flag field specifies the behavior of an auto indentation operation.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>AutoIndent_ClearLine</span> = 0x1</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If AutoIndent_ClearLine is set, then any line that is only whitespace will
be cleared to contain nothing at all. otherwise the line is filled with whitespace
to match the nearby indentation.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>AutoIndent_UseTab</span> = 0x2</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If AutoIndent_UseTab is set, then when putting in leading whitespace to align
code, as many tabs will be used as possible until the fine grained control of spaces
is needed to finish the alignment.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>AutoIndent_ExactAlignBlock</span> = 0x4</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If AutoIndent_ExactAlignBlock is set, then block comments are indented by putting
the first non-whitespace character of the line in line with the beginning of the comment.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>AutoIndent_FullTokens</span> = 0x8</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If AutoIndent_FullTokens is set, then the set of lines that are indented is
automatically expanded so that any token spanning multiple lines gets entirely indented.<br><br></div></div></div></div><hr><divid='Set_Buffer_Flag_doc'style='margin-bottom: 1cm;'><h4>§3.4.21: Set_Buffer_Flag</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Set_Buffer_Flag;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A Set_Buffer_Flag field specifies the behavior of an operation that sets the buffer of a view.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>SetBuffer_KeepOriginalGUI</span> = 0x1</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If SetBuffer_KeepOriginalGUI then when the file is set, the view will not switch to it
switches to the file.<br><br></div></div></div></div><hr><divid='Input_Type_Flag_doc'style='margin-bottom: 1cm;'><h4>§3.4.22: Input_Type_Flag</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Input_Type_Flag;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A Input_Type_Flag field specifies a set of input event types.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>EventOnAnyKey</span> = 0x1</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If EventOnAnyKey is set, all keyboard events are included in the set.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>EventOnEsc</span> = 0x2</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If EventOnEsc is set, any press of the escape key is included in the set.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>EventOnLeftButton</span> = 0x4</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If EventOnLeftButton is set, left clicks are included in the set.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>EventOnRightButton</span> = 0x8</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If EventOnRightButton is set, right clicks are included in the set.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>EventOnWheel</span> = 0x10</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If EventOnWheel is set, any wheel movement is included in the set.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>EventOnMouseMove</span> = 0x20</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is not totally implemented yet.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>EventOnButton</span> = (EventOnLeftButton | EventOnRightButton | EventOnWheel)</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If EventOnButton is set, all mouse button events are included in the set.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>EventOnMouse</span> = (EventOnButton | EventOnMouseMove)</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is not totally implemented yet.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>EventAll</span> = 0xFF</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>EventAll is a catch all name for including all possible events in the set.<br><br></div></div></div></div><hr><divid='Mouse_Cursor_Show_Type_doc'style='margin-bottom: 1cm;'><h4>§3.4.23: Mouse_Cursor_Show_Type</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Mouse_Cursor_Show_Type;</div><divstyle='margin-top
coordinates are suppose to be used for the seek.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>buffer_seek_pos</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This value indicates absolute positioning where positions are measured as the number of bytes from the start of the file.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>buffer_seek_wrapped_xy</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This value indicates xy positioning with wrapped lines where the x and y values are in pixels.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>buffer_seek_unwrapped_xy</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This value indicates xy positioning with unwrapped lines where the x and y values are in pixels.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>buffer_seek_line_char</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This value indicates line-character, or line-column positioning. These coordinates are 1 based to match standard line numbering.<br><br></div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Buffer_Seek_doc'>Buffer_Seek</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr><divid='View_Split_Position_doc'style='margin-bottom: 1cm;'><h4>§3.4.25: View_Split_Position</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum View_Split_Position;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A View_Split_Position specifies where a new view should be placed as a result of
a view split operation.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>ViewSplit_Top</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This value indicates that the new view should be above the existing view.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>ViewSplit_Bottom</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This value indicates that the new view should be below the existing view.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>ViewSplit_Left</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This value indicates that the new view should be left of the existing view.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>ViewSplit_Right</span></span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This value indicates that the new view should be right of the existing view.<br><br></div></div></div></div><hr><divid='Generic_Command_doc'style='margin-bottom: 1cm;'><h4>§3.4.26: Generic_Command</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>union Generic_Command {<br><divstyle='margin-left: 8mm;'>Command_ID cmdid;<br>Custom_Command_Function * command;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Generic_Command acts as a name for a command, and can name an
internal command or a custom command.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>cmdid</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this Generic_Command represents an internal command the cmdid field
will have a value less than cmdid_count, and this field is the command id for the command.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>command</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this Generic_Command does not represent an internal command the command
at the time of the event.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>keycode</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field is the raw keycode which is always non-zero in valid key events.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>character</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field is the keycode after translation to a character, this is 0 if there is no translation.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>character_no_caps_lock</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field is like the field character, except that the state of caps lock is ignored in the translation.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>modifiers</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field is an array indicating the state of modifiers at the time of the key press.
The array is indexed using the values of Key_Modifier. A 1 indicates that the corresponding
or not the mouse if in the window.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>l</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the left button is held.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>r</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the right button is held.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>press_l</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the left button was pressed this frame.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>press_r</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the right button was pressed this frame.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>release_l</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the left button was released this frame.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>release_r</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the right button was released this frame.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>wheel</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field is 0 when the wheel has not moved, it is 1 for a downward motion and -1 for an upward motion.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>out_of_window</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the mouse is outside of the window.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>x</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the x position of the mouse relative to the window where the left side is 0.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>y</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the y position of the mouse relative to the window where the top side is 0.<br><br></div></div></div></div><hr><divid='Range_doc'style='margin-bottom: 1cm;'><h4>§3.4.29: Range</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>union Range {<br><divstyle='margin-left: 8mm;'>struct {<br><divstyle='margin-left: 8mm;'>int32_t min;<br>int32_t max;<br></div>};<br>struct {<br><divstyle='margin-left: 8mm;'>int32_t start;<br>int32_t end;<br></div>};<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Range describes an integer range typically used for ranges within a buffer.
Throughout the API ranges are thought of in the form [min,max<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>min</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is the smaller value in the range, it is also the 'start'.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>max</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is the larger value in the range, it is also the 'end'.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>start</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is the start of the range, it is also the 'min'.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>end</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is the end of the range, it is also the 'max'.<br><br></div></div></div></div><hr><divid='File_Info_doc'style='margin-bottom: 1cm;'><h4>§3.4.30: File_Info</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct File_Info {<br><divstyle='margin-left: 8mm;'>char * filename;<br>int32_t filename_len;<br>int32_t folder;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>File_Info describes the name and type of a file.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>filename</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field is a null terminated string specifying the name of the file.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>filename_len</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field specifies the length of the filename string not counting the null terminator.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>folder</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the description is for a folder not a file.<br><br></div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#File_List_doc'>File_List</a></div></div><hr><divid='File_List_doc'style='margin-bottom: 1cm;'><h4>§3.4.31: File_List</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct File_List {<br><divstyle='margin-left: 8mm;'>void * block;<br>File_Info * infos;<br>int32_t count;<br>int32_t block_size;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>File_List is a list of File_Info structs.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>block</span></div><divstyle='margin-bottom: 6mm;'
can either be a name or an id. If the<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>name</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field is the name of the buffer; it need not be null terminated.
the buffer is associated with a view to give the x/y values meaning.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>pos</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the cursor's position in absolute positioning.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>line</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the number of the line where the cursor is located. This field is one based.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>character</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the number of the column where the cursor is located. This field is one based.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>unwrapped_x</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the x position measured with unwrapped lines.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>unwrapped_y</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the y position measured with unwrapped lines.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>wrapped_x</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the x position measured with wrapped lines.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>wrapped_y</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the y position measured with wrapped lines.<br><br></div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr><divid='Partial_Cursor_doc'style='margin-bottom: 1cm;'><h4>§3.4.35: Partial_Cursor</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Partial_Cursor {<br><divstyle='margin-left: 8mm;'>int32_t pos;<br>int32_t line;<br>int32_t character;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Partial_Cursor describes the position of a cursor in all of
not currently associated with a View.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>pos</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the cursor's position in absolute positioning.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>line</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the number of the line where the cursor is located. This field is one based.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>character</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field contains the number of the column where the cursor is located. This field is one based.<br><br></div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr><divid='Buffer_Seek_doc'style='margin-bottom: 1cm;'><h4>§3.4.36: Buffer_Seek</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Buffer_Seek {<br><divstyle='margin-left: 8mm;'>Buffer_Seek_Type type;<br>union {<br><divstyle='margin-left: 8mm;'>struct {<br><divstyle='margin-left: 8mm;'>int32_t pos;<br></div>};<br>struct {<br><divstyle='margin-left: 8mm;'>bool32 round_down;<br>float x;<br>float y;<br></div>};<br>struct {<br><divstyle='margin-left: 8mm;'>int32_t line;<br>int32_t character;<br></div>};<br></div>};<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Buffer_Seek describes the destination of a seek operation. There are helpers
for concisely creating Buffer_Seek structs. They can be found in 4coder_buffer_types.h.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>type</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The type field determines the coordinate system of the seek operation.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>pos</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The pos field specified the pos when the seek is in absolute position.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>round_down</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>For xy coordinate seeks, rounding down means that any x in the box of the
character lands on that character. For instance when clicking rounding down is the
user's expected behavior. Not rounding down means that the right hand portion of
the character's box, which is closer to the next character, will land on that next
character. The unrounded behavior is the expected behavior when moving vertically
will be replaced into the buffer.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>str_start</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str_start field specifies the first character in the accompanying string that corresponds with this edit.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>len</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The len field specifies the length of the string being written into the buffer.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>start</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start field specifies the start of the range in the buffer to replace in absolute position.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>end</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The end field specifies one past the end of the range in the buffer to replace in absolute position.<br><br></div></div></div></div><hr><divid='Buffer_Summary_doc'style='margin-bottom: 1cm;'><h4>§3.4.38: Buffer_Summary</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Buffer_Summary {<br><divstyle='margin-left: 8mm;'>bool32 exists;<br>bool32 ready;<br>int32_t buffer_id;<br>Access_Flag lock_flags;<br>int32_t size;<br>int32_t line_count;<br>char * file_name;<br>int32_t file_name_len;<br>char * buffer_name;<br>int32_t buffer_name_len;<br>Dirty_State dirty;<br>bool32 is_lexed;<br>bool32 tokens_are_ready;<br>int32_t map_id;<br>bool32 unwrapped_lines;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Buffer_Summary acts as a handle to a buffer and describes the state of the buffer.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>exists</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates whether the Buffer_Summary describes a buffer that is open in 4coder.
When this field is false the summary is referred to as a "null summary".<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>ready</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field indicates whether the buffer has finished loading.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>buffer_id</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary this field is the id of the associated buffer.
If this is a null summary then buffer_id is 0.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>lock_flags</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field contains flags describing the protection status of the buffer.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>size</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the size of the text in the buffer.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>line_count</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the number of lines in the buffer.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>file_name</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the file name associated to this buffer.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>file_name_len</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field specifies the length of the file_name string.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>buffer_name</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the name of the buffer.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>buffer_name_len</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field specifies the length of the buffer_name string.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>dirty</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates the dirty state of the buffer.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>is_lexed</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field indicates whether the buffer is set to lex tokens.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>tokens_are_ready</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field indicates whether the buffer has up to date tokens available.
it's tokens up to date.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>map_id</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the id of the command map for this buffer.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>unwrapped_lines</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field indicates whether the buffer 'prefers' wrapped lines.<br><br></div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Access_Flag_doc'>Access_Flag</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Dirty_State_doc'>Dirty_State</a></div></div><hr><divid='View_Summary_doc'style='margin-bottom: 1cm;'><h4>§3.4.39: View_Summary</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct View_Summary {<br><divstyle='margin-left: 8mm;'>bool32 exists;<br>int32_t view_id;<br>int32_t buffer_id;<br>Access_Flag lock_flags;<br>Full_Cursor cursor;<br>Full_Cursor mark;<br>float preferred_x;<br>float line_height;<br>bool32 unwrapped_lines;<br>bool32 show_whitespace;<br>i32_Rect file_region;<br>GUI_Scroll_Vars scroll_vars;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>View_Summary acts as a handle to a view and describes the state of the view.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>exists</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This field indicates whether the View_Summary describes a view that is open in 4coder.
When this field is false the summary is referred to as a "null summary".<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>view_id</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field is the id of the associated view.
If this is a null summary then view_id is 0.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>buffer_id</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, then this is the id of the buffer this view currently sees.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>lock_flags</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field contains flags describing the protection status of the view.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>cursor</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this describes the position of the cursor.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>mark</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this describes the position of the mark.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>preferred_x</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this is the x position that is maintained in vertical navigation.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>line_height</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this specifies the height of a line rendered in the view.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>unwrapped_lines</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this indicates that the view is set to render with unwrapped lines.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>show_whitespace</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this indicates that the view is set to highlight white space.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>file_region</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this describes the screen position in which this view's buffer is displayed.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>scroll_vars</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this describes the scrolling position inside the view.<br><br></div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Access_Flag_doc'>Access_Flag</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Full_Cursor_doc'>Full_Cursor</a></div></div><hr><divid='User_Input_doc'style='margin-bottom: 1cm;'><h4>§3.4.40: User_Input</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct User_Input {<br><divstyle='margin-left: 8mm;'>User_Input_Type_ID type;
that will be displayed as a drop down bar durring an interactive command.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>prompt</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This specifies the prompt portion of the drop down bar.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>string</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This specifies the main string portion of the drop down bar.<br><br></div></div></div></div><hr><divid='Event_Message_doc'style='margin-bottom: 1cm;'><h4>§3.4.42: Event_Message</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Event_Message {<br><divstyle='margin-left: 8mm;'>int32_t type;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This feature is not implemented.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>type</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This feature is not implemented.<br><br></div></div></div></div><hr><divid='Theme_Color_doc'style='margin-bottom: 1cm;'><h4>§3.4.43: Theme_Color</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Theme_Color {<br><divstyle='margin-left: 8mm;'>Style_Tag tag;<br>int_color color;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Theme_Color stores a style tag/color pair, for the purpose of setting and getting colors in the theme.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>tag</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The style slot in the style palette.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>color</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The color in the slot.<br><br></div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Style_Tag_doc'>Style_Tag</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#int_color_doc'>int_color</a></div></div><hr><divid='Buffer_Batch_Edit_Type_doc'style='margin-bottom: 1cm;'><h4>§3.4.44: Buffer_Batch_Edit_Type</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Buffer_Batch_Edit_Type;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A Buffer_Batch_Edit_Type is a type of batch operation.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>BatchEdit_Normal</span></span></div><divstyle='margin-bottom: 6mm;'><div
This usually applies when whitespace is being replaced with whitespace.<br><br></div></div></div></div><hr><divid='Buffer_Batch_Edit_doc'style='margin-bottom: 1cm;'><h4>§3.4.45: Buffer_Batch_Edit</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Buffer_Batch_Edit {<br><divstyle='margin-left: 8mm;'>char * str;<br>int32_t str_len;<br>Buffer_Edit * edits;<br>int32_t edit_count;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This struct is used to bundle the parameters of the buffer_batch_edit function. It is convenient
<h2id='section_string_library'>§4 String Library</h2><h3>§4.1 String Intro</h3><div><i>Coming Soon</i><div><h3>§4.2 String Function List</h3><ul><li><ahref='#char_is_slash_doc'>char_is_slash</a></li><li><ahref='#char_is_upper_doc'>char_is_upper</a></li><li><ahref='#char_is_lower_doc'>char_is_lower</a></li><li><ahref='#char_to_upper_doc'>char_to_upper</a></li><li><ahref='#char_to_lower_doc'>char_to_lower</a></li><li><ahref='#char_is_whitespace_doc'>char_is_whitespace</a></li><li><ahref='#char_is_alpha_numeric_doc'>char_is_alpha_numeric</a></li><li><ahref='#char_is_alpha_numeric_true_doc'>char_is_alpha_numeric_true</a></li><li><ahref='#char_is_alpha_doc'>char_is_alpha</a></li><li><ahref='#char_is_alpha_true_doc'>char_is_alpha_true</a></li><li><ahref='#char_is_hex_doc'>char_is_hex</a></li><li><ahref='#char_is_numeric_doc'>char_is_numeric</a></li><li><ahref='#make_string_cap_doc'>make_string_cap</a></li><li><ahref='#make_string_doc'>make_string</a></li><li><ahref='#make_lit_string_doc'>make_lit_string</a></li><li><ahref='#make_fixed_width_string_doc'>make_fixed_width_string</a></li><li><ahref='#expand_str_doc'>expand_str</a></li><li><ahref='#str_size_doc'>str_size</a></li><li><ahref='#make_string_slowly_doc'>make_string_slowly</a></li><li><ahref='#substr_tail_doc'>substr_tail</a></li><li><ahref='#substr_doc'>substr</a></li><li><ahref='#skip_whitespace_doc'>skip_whitespace</a></li><li><ahref='#chop_whitespace_doc'>chop_whitespace</a></li><li><ahref='#skip_chop_whitespace_doc'>skip_chop_whitespace</a></li><li><ahref='#tailstr_doc'>tailstr</a></li><li><ahref='#match_cc_doc'>match_cc</a></li><li><ahref='#match_sc_doc'>match_sc</a></li><li><ahref='#match_cs_doc'>match_cs</a></li><li><ahref='#match_ss_doc'>match_ss</a></li><li><ahref='#match_part_ccl_doc'>match_part_ccl</a></li><li><ahref='#match_part_scl_doc'>match_part_scl</a></li><li><ahref='#match_part_cc_doc'>match_part_cc</a></li><li><ahref='#match_part_sc_doc'>match_part_sc</a></li><li><ahref='#match_part_cs_doc'>match_part_cs</a></li><li><ahref='#match_part_ss_doc'>match_part_ss</a></li><li><ahref='#match_insensitive_cc_doc'>match_insensitive_cc</a></li><li><ahref='#match_insensitive_sc_doc'>match_insensitive_sc</a></li><li><ahref='#match_insensitive_cs_doc'>match_insensitive_cs</a></li><li><ahref='#match_insensitive_ss_doc'>match_insensitive_ss</a></li><li><ahref='#match_part_insensitive_ccl_doc'>match_part_insensitive_ccl</a></li><li><ahref='#match_part_insensitive_scl_doc'>match_part_insensitive_scl</a></li><li><ahref='#match_part_insensitive_cc_doc'>match_part_insensitive_cc</a></li><li><ahref='#match_part_insensitive_sc_doc'>match_part_insensitive_sc</a></li><li><ahref='#match_part_insensitive_cs_doc'>match_part_insensitive_cs</a></li><li><ahref='#match_part_insensitive_ss_doc'>match_part_insensitive_ss</a></li><li><ahref='#compare_cc_doc'>compare_cc</a></li><li><ahref='#compare_sc_doc'>compare_sc</a></li><li><ahref='#compare_cs_doc'>compare_cs</a></li><li><ahref='#compare_ss_doc'>compare_ss</a></li><li><ahref='#find_c_char_doc'>find_c_char</a></li><li><ahref='#find_s_char_doc'>find_s_char</a></li><li><ahref='#rfind_s_char_doc'>rfind_s_char</a></li><li><ahref='#find_c_chars_doc'>find_c_chars</a></li><li><ahref='#find_s_chars_doc'>find_s_chars</a></li><li><ahref='#find_substr_c_doc'>find_substr_c</a></li><li><ahref='#find_substr_s_doc'>find_substr_s</a></li><li><ahref='#rfind_substr_s_doc'>rfind_substr_s</a></li><li><ahref='#find_substr_insensitive_c_doc'>find_substr_insensitive_c</a></li><li><ahref='#find_substr_insensitive_s_doc'>find_substr_insensitive_s</a></li><li><ahref='#has_substr_c_doc'>has_substr_c</a></li><li><ahref='#has_substr_s_doc'>has_substr_s</a></li><li><ahref='#has_substr_insensitive_c_doc'>has_substr_insensitive_c</a></li><li><ahref='#has_substr_insensitive_s_doc'>has_substr_insensitive_s</a></li><li><ahref='#copy_fast_unsafe_cc_doc'>copy_fast_unsafe_cc</a></li><li><ahref='#copy_fast_unsafe_cs_doc'>copy_fast_unsafe_cs</a></li><li><ahref='#copy_checked_ss_doc'>copy_che
If the memory does not already contain a useful string this should be zero.</div></div></div><div><divstyle='font-weight: 600;'>mem_size</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The mem_size parameter expresses the full size of the memory provided by str.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the String created from the parameters.<br><br></div></div></div><hr><divid='make_string_doc'style='margin-bottom: 1cm;'><h4>§4.3.14: make_string</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>String make_string(<divstyle='margin-left: 4mm;'>void *str,<br>int32_t size<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides the of memory with which the string shall operate.</div></div></div><div><divstyle='font-weight: 600;'>size</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The size parameter expresses the initial size of the string.
of the memory.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the String created from the parameters.<br><br></div></div><hr><divid='make_lit_string_doc'style='margin-bottom: 1cm;'><h4>§4.3.15: make_lit_string</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>#define make_lit_string(s)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This macro takes a literal string in quotes and uses it to create a String
with the correct size and memory size. Strings created this way should usually not be mutated.<br><br></div></div><hr><divid='make_fixed_width_string_doc'style='margin-bottom: 1cm;'><h4>§4.3.16: make_fixed_width_string</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>#define make_fixed_width_string(s)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This macro takes a local char array with a fixed width and uses it to create
an empty String with the correct size and memory size to operate on the array.<br><br></div></div><hr><divid='expand_str_doc'style='margin-bottom: 1cm;'><h4>§4.3.17: expand_str</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>#define expand_str(s)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This macro is a helper for any calls that take a char*,integer pair to specify a
string. This macro expands to both of those parameters from one String struct.<br><br></div></div><hr><divid='str_size_doc'style='margin-bottom: 1cm;'><h4>§4.3.18: str_size</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t str_size(<divstyle='margin-left: 4mm;'>char *str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of bytes before a null terminator starting at str.<br><br></div></div><hr><divid='make_string_slowly_doc'style='margin-bottom: 1cm;'><h4>§4.3.19: make_string_slowly</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>String make_string_slowly(<divstyle='margin-left: 4mm;'>void *str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call makes a string by counting the number of bytes before a null terminator and
treating that as the size and memory size of the string.<br><br></div></div><hr><divid='substr_tail_doc'style='margin-bottom: 1cm;'><divid='substr_doc'><h4>§4.3.20: substr_tail</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>String substr_tail(<divstyle='margin-left: 4mm;'>String str,<br>int32_t start<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call creates a substring of str that starts with an offset from str's base.
Usually strings created this way should only go through immutable calls.<br><br></div></div></div><hr><divid='substr_doc'style='margin-bottom: 1cm;'><h4>§4.3.21: substr</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>String substr(<divstyle='margin-left: 4mm;'>String str,<br>int32_t start,<br>int32_t size<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call creates a substring of str that starts with an offset from str's base,
will see changes. Usually strings created this way should only go through immutable calls.<br><br></div></div><hr><divid='skip_whitespace_doc'style='margin-bottom: 1cm;'><h4>§4.3.22: skip_whitespace</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>String skip_whitespace(<divstyle='margin-left: 4mm;'>String str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call creates a substring that starts with the first non-whitespace character of str.
the portion of str's memory that is not used.<br><br></div></div><hr><divid='match_cc_doc'style='margin-bottom: 1cm;'><divid='match_doc'><h4>§4.3.26: match_cc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_cc(<divstyle='margin-left: 4mm;'>char *a,<br>char *b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent.<br><br></div></div></div><hr><divid='match_sc_doc'style='margin-bottom: 1cm;'><h4>§4.3.27: match_sc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_sc(<divstyle='margin-left: 4mm;'>String a,<br>char *b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent.<br><br></div></div><hr><divid='match_cs_doc'style='margin-bottom: 1cm;'><h4>§4.3.28: match_cs</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_cs(<divstyle='margin-left: 4mm;'>char *a,<br>String b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent.<br><br></div></div><hr><divid='match_ss_doc'style='margin-bottom: 1cm;'><h4>§4.3.29: match_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_ss(<divstyle='margin-left: 4mm;'>String a,<br>String b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent.<br><br></div></div><hr><divid='match_part_ccl_doc'style='margin-bottom: 1cm;'><divid='match_part_doc'><h4>§4.3.30: match_part_ccl</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_part_ccl(<divstyle='margin-left: 4mm;'>char *a,<br>char *b,<br>int32_t *len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this call returns non-zero this parameter is used to output the length of b.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call is similar to a match call, except that it is permitted for a to be longer than b.
In other words this call returns non-zero if b is a prefix of a.<br><br></div></div></div><hr><divid='match_part_scl_doc'style='margin-bottom: 1cm;'><h4>§4.3.31: match_part_scl</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_part_scl(<divstyle='margin-left: 4mm;'>String a,<br>char *b,<br>int32_t *len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this call returns non-zero this parameter is used to output the length of b.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call is similar to a match call, except that it is permitted for a to be longer than b.
In other words this call returns non-zero if b is a prefix of a.<br><br></div></div><hr><divid='match_part_cc_doc'style='margin-bottom: 1cm;'><h4>§4.3.32: match_part_cc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_part_cc(<divstyle='margin-left: 4mm;'>char *a,<br>char *b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this call returns non-zero this parameter is used to output the length of b.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call is similar to a match call, except that it is permitted for a to be longer than b.
In other words this call returns non-zero if b is a prefix of a.<br><br></div></div><hr><divid='match_part_sc_doc'style='margin-bottom: 1cm;'><h4>§4.3.33: match_part_sc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_part_sc(<divstyle='margin-left: 4mm;'>String a,<br>char *b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call is similar to a match call, except that it is permitted for a to be longer than b.
In other words this call returns non-zero if b is a prefix of a.<br><br></div></div><hr><divid='match_part_cs_doc'style='margin-bottom: 1cm;'><h4>§4.3.34: match_part_cs</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_part_cs(<divstyle='margin-left: 4mm;'>char *a,<br>String b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call is similar to a match call, except that it is permitted for a to be longer than b.
In other words this call returns non-zero if b is a prefix of a.<br><br></div></div><hr><divid='match_part_ss_doc'style='margin-bottom: 1cm;'><h4>§4.3.35: match_part_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_part_ss(<divstyle='margin-left: 4mm;'>String a,<br>String b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call is similar to a match call, except that it is permitted for a to be longer than b.
In other words this call returns non-zero if b is a prefix of a.<br><br></div></div><hr><divid='match_insensitive_cc_doc'style='margin-bottom: 1cm;'><divid='match_insensitive_doc'><h4>§4.3.36: match_insensitive_cc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_insensitive_cc(<divstyle='margin-left: 4mm;'>char *a,<br>char *b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent under case insensitive comparison.<br><br></div></div></div><hr><divid='match_insensitive_sc_doc'style='margin-bottom: 1cm;'><h4>§4.3.37: match_insensitive_sc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_insensitive_sc(<divstyle='margin-left: 4mm;'>String a,<br>char *b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent under case insensitive comparison.<br><br></div></div><hr><divid='match_insensitive_cs_doc'style='margin-bottom: 1cm;'><h4>§4.3.38: match_insensitive_cs</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_insensitive_cs(<divstyle='margin-left: 4mm;'>char *a,<br>String b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent under case insensitive comparison.<br><br></div></div><hr><divid='match_insensitive_ss_doc'style='margin-bottom: 1cm;'><h4>§4.3.39: match_insensitive_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_insensitive_ss(<divstyle='margin-left: 4mm;'>String a,<br>String b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent under case insensitive comparison.<br><br></div></div><hr><divid='match_part_insensitive_ccl_doc'style='margin-bottom: 1cm;'><divid='match_part_insensitive_doc'><h4>§4.3.40: match_part_insensitive_ccl</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool match_part_insensitive_ccl(<divstyle='margin-left: 4mm;'>char *a,<br>char *b,<br>int32_t *len<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>len</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this call returns non-zero this parameter is used to output the length of b.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call performs the same partial matching rule as match_part under case insensitive comparison.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#match_part_doc'>match_part</a></div></div></div><hr><divid='match_part_insensitive_scl_doc'style='margin-bottom: 1cm;'><h4>§4.3.41: match_part_insensitive_scl</h4><divstyle='font-family:"CourierNew",Courier,monospace;text-align:left;
and positive if a sorts after b alphabetically.<br><br></div></div></div><hr><divid='compare_sc_doc'style='margin-bottom: 1cm;'><h4>§4.3.47: compare_sc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t compare_sc(<divstyle='margin-left: 4mm;'>String a,<br>char *b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns zero if a and b are equivalent,
and positive if a sorts after b alphabetically.<br><br></div></div><hr><divid='compare_cs_doc'style='margin-bottom: 1cm;'><h4>§4.3.48: compare_cs</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t compare_cs(<divstyle='margin-left: 4mm;'>char *a,<br>String b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns zero if a and b are equivalent,
and positive if a sorts after b alphabetically.<br><br></div></div><hr><divid='compare_ss_doc'style='margin-bottom: 1cm;'><h4>§4.3.49: compare_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t compare_ss(<divstyle='margin-left: 4mm;'>String a,<br>String b<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns zero if a and b are equivalent,
and positive if a sorts after b alphabetically.<br><br></div></div><hr><divid='find_c_char_doc'style='margin-bottom: 1cm;'><divid='find_doc'><h4>§4.3.50: find_c_char</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t find_c_char(<divstyle='margin-left: 4mm;'>char *str,<br>int32_t start,<br>char character<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a null terminated string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>character</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The character parameter provides the character for which to search.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the index of the first occurance of character, or the size of the string
if the character is not found.<br><br></div></div></div><hr><divid='find_s_char_doc'style='margin-bottom: 1cm;'><h4>§4.3.51: find_s_char</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t find_s_char(<divstyle='margin-left: 4mm;'>String str,<br>int32_t start,<br>char character<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>character</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The character parameter provides the character for which to search.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the index of the first occurance of character, or the size of the string
if the character is not found.<br><br></div></div><hr><divid='rfind_s_char_doc'style='margin-bottom: 1cm;'><divid='rfind_doc'><h4>§4.3.52: rfind_s_char</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t rfind_s_char(<divstyle='margin-left: 4mm;'>String str,<br>int32_t start,<br>char character<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>character</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The character parameter provides the character for which to search.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call looks for the largest index less than or equal to the start position where
the given character occurs. If the index is found it is returned otherwise -1 is returned.<br><br></div></div></div><hr><divid='find_c_chars_doc'style='margin-bottom: 1cm;'><h4>§4.3.53: find_c_chars</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t find_c_chars(<divstyle='margin-left: 4mm;'>char *str,<br>int32_t start,<br>char *characters<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a null terminated string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>character</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The characters parameter provides a null terminated array of characters for which to search.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the index of the first occurance of a character in the characters array,
or the size of the string if no such character is not found.<br><br></div></div><hr><divid='find_s_chars_doc'style='margin-bottom: 1cm;'><h4>§4.3.54: find_s_chars</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t find_s_chars(<divstyle='margin-left: 4mm;'>String str,<br>int32_t start,<br>char *characters<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>character</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The characters parameter provides a null terminated array of characters for which to search.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the index of the first occurance of a character in the characters array,
or the size of the string if no such character is not found.<br><br></div></div><hr><divid='find_substr_c_doc'style='margin-bottom: 1cm;'><divid='find_substr_doc'><h4>§4.3.55: find_substr_c</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t find_substr_c(<divstyle='margin-left: 4mm;'>char *str,<br>int32_t start,<br>String seek<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a null terminated string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>seek</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the index of the first occurance of the seek substring in str or the
size of str if no such substring in str is found.<br><br></div></div></div><hr><divid='find_substr_s_doc'style='margin-bottom: 1cm;'><h4>§4.3.56: find_substr_s</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t find_substr_s(<divstyle='margin-left: 4mm;'>String str,<br>int32_t start,<br>String seek<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>seek</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the index of the first occurance of the seek substring in str or the
size of str if no such substring in str is found.<br><br></div></div><hr><divid='rfind_substr_s_doc'style='margin-bottom: 1cm;'><divid='rfind_substr_doc'><h4>§4.3.57: rfind_substr_s</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t rfind_substr_s(<divstyle='margin-left: 4mm;'>String str,<br>int32_t start,<br>String seek<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>seek</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the index of the last occurance of the seek substring in str
or -1 if no such substring in str is found.<br><br></div></div></div><hr><divid='find_substr_insensitive_c_doc'style='margin-bottom: 1cm;'><divid='find_substr_insensitive_doc'><h4>§4.3.58: find_substr_insensitive_c</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t find_substr_insensitive_c(<divstyle='margin-left: 4mm;'>char *str,<br>int32_t start,<br>String seek<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a null terminated string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>seek</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call acts as find_substr under case insensitive comparison.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#find_substr_doc'>find_substr</a></div></div></div><hr><divid='find_substr_insensitive_s_doc'style='margin-bottom: 1cm;'><h4>§4.3.59: find_substr_insensitive_s</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t find_substr_insensitive_s(<divstyle='margin-left: 4mm;'>String str,<br>int32_t start,<br>String seek<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div></div><div><divstyle='font-weight: 600;'>start</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div></div><div><divstyle='font-weight: 600;'>seek</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call acts as find_substr under case insensitive comparison.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#find_substr_doc'>find_substr</a></div></div><hr><divid='has_substr_c_doc'style='margin-bottom: 1cm;'><divid='has_substr_doc'><h4>§4.3.60: has_substr_c</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool has_substr_c(<divstyle='margin-left: 4mm;'>char *s,<br>String seek<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the string s contains a substring equivalent to seek.<br><br></div></div></div><hr><divid='has_substr_s_doc'style='margin-bottom: 1cm;'><h4>§4.3.61: has_substr_s</h4><divstyle='font-family:"CourierNew",Courier,monospace;text-align:left;margin-top:3mm;margin-bottom:3mm;font-si
under case insensitive comparison.<br><br></div></div></div><hr><divid='has_substr_insensitive_s_doc'style='margin-bottom: 1cm;'><h4>§4.3.63: has_substr_insensitive_s</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool has_substr_insensitive_s(<divstyle='margin-left: 4mm;'>String s,<br>String seek<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the string s contains a substring equivalent to seek
under case insensitive comparison.<br><br></div></div><hr><divid='copy_fast_unsafe_cc_doc'style='margin-bottom: 1cm;'><divid='copy_fast_unsafe_doc'><h4>§4.3.64: copy_fast_unsafe_cc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t copy_fast_unsafe_cc(<divstyle='margin-left: 4mm;'>char *dest,<br>char *src<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from the src buffer to the dest buffer.
if the entire string is coppied to dest.<br><br></div></div></div><hr><divid='copy_partial_ss_doc'style='margin-bottom: 1cm;'><h4>§4.3.68: copy_partial_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool copy_partial_ss(<divstyle='margin-left: 4mm;'>String *dest,<br>String src<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from the src string to the dest string.
if the entire string is coppied to dest.<br><br></div></div><hr><divid='copy_cc_doc'style='margin-bottom: 1cm;'><divid='copy_doc'><h4>§4.3.69: copy_cc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t copy_cc(<divstyle='margin-left: 4mm;'>char *dest,<br>char *src<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from src to dest equivalent to copy_fast_unsafe.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#copy_fast_unsafe_doc'>copy_fast_unsafe</a></div></div></div><hr><divid='copy_ss_doc'style='margin-bottom: 1cm;'><h4>§4.3.70: copy_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void copy_ss(<divstyle='margin-left: 4mm;'>String *dest,<br>String src<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from src to dest equivalent to copy_checked.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#copy_checked_doc'>copy_checked</a></div></div><hr><divid='copy_sc_doc'style='margin-bottom: 1cm;'><h4>§4.3.71: copy_sc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void copy_sc(<divstyle='margin-left: 4mm;'>String *dest,<br>char *src<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from src to dest equivalent to copy_partial.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#copy_partial_doc'>copy_partial</a></div></div><hr><divid='append_checked_ss_doc'style='margin-bottom: 1cm;'><divid='append_checked_doc'><h4>§4.3.72: append_checked_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool append_checked_ss(<divstyle='margin-left: 4mm;'>String *dest,<br>String src<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call checks if there is enough space in dest's underlying memory
to append src onto dest. If there is src is appended and the call returns non-zero.<br><br></div></div></div><hr><divid='append_partial_sc_doc'style='margin-bottom: 1cm;'><divid='append_partial_doc'><h4>§4.3.73: append_partial_sc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool append_partial_sc(<divstyle='margin-left: 4mm;'>String *dest,<br>char *src<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call attemps to append as much of src into the space in dest's underlying memory
as possible. If the entire string is appended the call returns non-zero.<br><br></div></div></div><hr><divid='append_partial_ss_doc'style='margin-bottom: 1cm;'><h4>§4.3.74: append_partial_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool append_partial_ss(<divstyle='margin-left: 4mm;'>String *dest,<br>String src<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call attemps to append as much of src into the space in dest's underlying memory
as possible. If the entire string is appended the call returns non-zero.<br><br></div></div><hr><divid='append_s_char_doc'style='margin-bottom: 1cm;'><divid='append_doc'><h4>§4.3.75: append_s_char</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool append_s_char(<divstyle='margin-left: 4mm;'>String *dest,<br>char c<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call attemps to append c onto dest. If there is space left in dest's underlying
byte in the strings underlying memory.<br><br></div></div><hr><divid='append_padding_doc'style='margin-bottom: 1cm;'><h4>§4.3.79: append_padding</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool append_padding(<divstyle='margin-left: 4mm;'>String *dest,<br>char c,<br>int32_t target_size<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call pads out dest so that it has a size of target_size by appending
non-zero if dest does not run out of space in the underlying memory.<br><br></div></div><hr><divid='replace_char_doc'style='margin-bottom: 1cm;'><h4>§4.3.80: replace_char</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void replace_char(<divstyle='margin-left: 4mm;'>String *str,<br>char replace,<br>char with<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides the string in which replacement shall be performed.</div></div></div><div><divstyle='font-weight: 600;'>replace</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The replace character specifies which character should be replaced.</div></div></div><div><divstyle='font-weight: 600;'>with</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The with character specifies what to write into the positions where replacement occurs.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call replaces all occurances of character in str with another character.<br><br></div></div><hr><divid='to_lower_cc_doc'style='margin-bottom: 1cm;'><divid='to_lower_doc'><h4>§4.3.81: to_lower_cc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void to_lower_cc(<divstyle='margin-left: 4mm;'>char *src,<br>char *dst<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>src</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The source string to conver to lowercase. This string must be null terminated.</div></div></div><div><divstyle='font-weight: 600;'>dst</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The destination buffer to receive the converted string. This must be large
enough to contain all of src and a null terminator.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Rewrites the string in src into dst with all letters lowercased. src and dst should not
overlap with the exception that src and dst may be exactly equal in order to convert the
This must have a capacity of at least the size of src.</div></div></div><div><divstyle='font-weight: 600;'>src</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The source string to conver to lowercase.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Rewrites the string in src into dst. src and dst should not overlap with the exception
This must be large enough to contain all of src and a null terminator.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Rewrites the string in src into dst. src and dst should not overlap with the exception
that src and dst may be exactly equal in order to convert the string in place.<br><br></div></div></div><hr><divid='to_upper_ss_doc'style='margin-bottom: 1cm;'><h4>§4.3.85: to_upper_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void to_upper_ss(<divstyle='margin-left: 4mm;'>String *dst,<br>String src<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>dst</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The destination buffer to receive the converted string.
This must have a capacity of at least the size of src.</div></div></div><div><divstyle='font-weight: 600;'>src</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The source string to convert to uppercase.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Rewrites the string in src into dst. src and dst should not overlap with the exception
This must be large enough to contain all of src and a null terminator.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Rewrites the string in src into dst. src and dst should not overlap
with the exception that src and dst may be exactly equal in order to
convert the string in place.<br><br></div></div></div><hr><divid='int_to_str_size_doc'style='margin-bottom: 1cm;'><h4>§4.3.88: int_to_str_size</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t int_to_str_size(<divstyle='margin-left: 4mm;'>int32_t x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of bytes required to represent x as a string.<br><br></div></div><hr><divid='int_to_str_doc'style='margin-bottom: 1cm;'><h4>§4.3.89: int_to_str</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool int_to_str(<divstyle='margin-left: 4mm;'>String *dest,<br>int32_t x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call writes a string representation of x into dest. If there is enough
space in dest this call returns non-zero.<br><br></div></div><hr><divid='append_int_to_str_doc'style='margin-bottom: 1cm;'><h4>§4.3.90: append_int_to_str</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool append_int_to_str(<divstyle='margin-left: 4mm;'>String *dest,<br>int32_t x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call appends a string representation of x onto dest. If there is enough
space in dest this call returns non-zero.<br><br></div></div><hr><divid='u64_to_str_size_doc'style='margin-bottom: 1cm;'><h4>§4.3.91: u64_to_str_size</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t u64_to_str_size(<divstyle='margin-left: 4mm;'>uint64_t x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of bytes required to represent x as a string.<br><br></div></div><hr><divid='u64_to_str_doc'style='margin-bottom: 1cm;'><h4>§4.3.92: u64_to_str</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool u64_to_str(<divstyle='margin-left: 4mm;'>String *dest,<br>uint64_t x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call writes a string representation of x into dest. If there is enough
space in dest this call returns non-zero.<br><br></div></div><hr><divid='append_u64_to_str_doc'style='margin-bottom: 1cm;'><h4>§4.3.93: append_u64_to_str</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool append_u64_to_str(<divstyle='margin-left: 4mm;'>String *dest,<br>uint64_t x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call appends a string representation of x onto dest. If there is enough
space in dest this call returns non-zero.<br><br></div></div><hr><divid='float_to_str_size_doc'style='margin-bottom: 1cm;'><h4>§4.3.94: float_to_str_size</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t float_to_str_size(<divstyle='margin-left: 4mm;'>float x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of bytes required to represent x as a string.<br><br></div></div><hr><divid='append_float_to_str_doc'style='margin-bottom: 1cm;'><h4>§4.3.95: append_float_to_str</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool append_float_to_str(<divstyle='margin-left: 4mm;'>String *dest,<br>float x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call writes a string representation of x into dest. If there is enough
space in dest this call returns non-zero.<br><br></div></div><hr><divid='float_to_str_doc'style='margin-bottom: 1cm;'><h4>§4.3.96: float_to_str</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool float_to_str(<divstyle='margin-left: 4mm;'>String *dest,<br>float x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call appends a string representation of x onto dest. If there is enough
space in dest this call returns non-zero.<br><br></div></div><hr><divid='str_is_int_c_doc'style='margin-bottom: 1cm;'><divid='str_is_int_doc'><h4>§4.3.97: str_is_int_c</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t str_is_int_c(<divstyle='margin-left: 4mm;'>char *str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>If str is a valid string representation of an integer, this call returns non-zero<br><br></div></div></div><hr><divid='str_is_int_s_doc'style='margin-bottom: 1cm;'><h4>§4.3.98: str_is_int_s</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool str_is_int_s(<divstyle='margin-left: 4mm;'>String str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>If str is a valid string representation of an integer, this call returns non-zero.<br><br></div></div><hr><divid='str_to_int_c_doc'style='margin-bottom: 1cm;'><divid='str_to_int_doc'><h4>§4.3.99: str_to_int_c</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t str_to_int_c(<divstyle='margin-left: 4mm;'>char *str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>If str is a valid string representation of an integer, this call will return
the integer represented by the string. Otherwise this call returns zero.<br><br></div></div></div><hr><divid='str_to_int_s_doc'style='margin-bottom: 1cm;'><h4>§4.3.100: str_to_int_s</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t str_to_int_s(<divstyle='margin-left: 4mm;'>String str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>If str represents a valid string representation of an integer, this call will return
the integer represented by the string. Otherwise this call returns zero.<br><br></div></div><hr><divid='hexchar_to_int_doc'style='margin-bottom: 1cm;'><h4>§4.3.101: hexchar_to_int</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t hexchar_to_int(<divstyle='margin-left: 4mm;'>char c<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>If c is a valid hexadecimal digit [0-9a-fA-F] this call returns the value of
the integer value of the digit. Otherwise the return is some nonsense value.<br><br></div></div><hr><divid='int_to_hexchar_doc'style='margin-bottom: 1cm;'><h4>§4.3.102: int_to_hexchar</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>char int_to_hexchar(<divstyle='margin-left: 4mm;'>int32_t x<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>If x is in the range [0,15] this call returns the equivalent lowercase hexadecimal digit.
Otherwise the return is some nonsense value.<br><br></div></div><hr><divid='hexstr_to_int_doc'style='margin-bottom: 1cm;'><h4>§4.3.103: hexstr_to_int</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>uint32_t hexstr_to_int(<divstyle='margin-left: 4mm;'>String str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call interprets str has a hexadecimal representation of an integer and returns
the represented integer value.<br><br></div></div><hr><divid='color_to_hexstr_doc'style='margin-bottom: 1cm;'><h4>§4.3.104: color_to_hexstr</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool color_to_hexstr(<divstyle='margin-left: 4mm;'>String *s,<br>uint32_t color<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call fills s with the hexadecimal representation of the color.
If there is enough memory in s to represent the color this call returns non-zero.<br><br></div></div><hr><divid='hexstr_to_color_doc'style='margin-bottom: 1cm;'><h4>§4.3.105: hexstr_to_color</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool hexstr_to_color(<divstyle='margin-left: 4mm;'>String s,<br>uint32_t *out<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call interprets s as a color and writes the 32-bit integer representation into out.<br><br></div></div><hr><divid='reverse_seek_slash_pos_doc'style='margin-bottom: 1cm;'><divid='reverse_seek_slash_doc'><h4>§4.3.106: reverse_seek_slash_pos</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t reverse_seek_slash_pos(<divstyle='margin-left: 4mm;'>String str,<br>int32_t pos<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call searches for a slash in str by starting pos bytes from the end and going backwards.<br><br></div></div></div><hr><divid='reverse_seek_slash_doc'style='margin-bottom: 1cm;'><h4>§4.3.107: reverse_seek_slash</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t reverse_seek_slash(<divstyle='margin-left: 4mm;'>String str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call searches for a slash in str by starting at the end and going backwards.<br><br></div></div><hr><divid='front_of_directory_doc'style='margin-bottom: 1cm;'><h4>§4.3.108: front_of_directory</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>String front_of_directory(<divstyle='margin-left: 4mm;'>String dir<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns a substring of dir containing only the file name or
folder name furthest to the right in the directory.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#substr_doc'>substr</a></div></div><hr><divid='path_of_directory_doc'style='margin-bottom: 1cm;'><h4>§4.3.109: path_of_directory</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>String path_of_directory(<divstyle='margin-left: 4mm;'>String dir<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns a substring of dir containing the whole path except
for the final file or folder name.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#substr_doc'>substr</a></div></div><hr><divid='set_last_folder_sc_doc'style='margin-bottom: 1cm;'><divid='set_last_folder_doc'><h4>§4.3.110: set_last_folder_sc</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool set_last_folder_sc(<divstyle='margin-left: 4mm;'>String *dir,<br>char *folder_name,<br>char slash<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>dir</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The dir parameter is the directory string in which to set the last folder in the directory.</div></div></div><div><divstyle='font-weight: 600;'>folder_name</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The folder_name parameter is a null terminated string specifying the name to set
at the end of the directory.</div></div></div><div><divstyle='font-weight: 600;'>slash</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The slash parameter specifies what slash to use between names in the directory.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call deletes the last file name or folder name in the dir string and appends the new provided one.
If there is enough memory in dir this call returns non-zero.<br><br></div></div></div><hr><divid='set_last_folder_ss_doc'style='margin-bottom: 1cm;'><h4>§4.3.111: set_last_folder_ss</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool set_last_folder_ss(<divstyle='margin-left: 4mm;'>String *dir,<br>String folder_name,<br>char slash<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>dir</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The dir parameter is the directory string in which to set the last folder in the directory.</div></div></div><div><divstyle='font-weight: 600;'>folder_name</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The folder_name parameter is a string specifying the name to set at the end of the directory.</div></div></div><div><divstyle='font-weight: 600;'>slash</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The slash parameter specifies what slash to use between names in the directory.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call deletes the last file name or folder name in the dir string and appends the new provided one.
If there is enough memory in dir this call returns non-zero.<br><br></div></div><hr><divid='file_extension_doc'style='margin-bottom: 1cm;'><h4>§4.3.112: file_extension</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>String file_extension(<divstyle='margin-left: 4mm;'>String str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call returns a substring containing only the file extension of the provided filename.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#substr_doc'>substr</a></div></div><hr><divid='remove_extension_doc'style='margin-bottom: 1cm;'><h4>§4.3.113: remove_extension</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool remove_extension(<divstyle='margin-left: 4mm;'>String *str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call attemps to delete a file extension off the end of a filename.
This call returns non-zero on success.<br><br></div></div><hr><divid='remove_last_folder_doc'style='margin-bottom: 1cm;'><h4>§4.3.114: remove_last_folder</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool remove_last_folder(<divstyle='margin-left: 4mm;'>String *str<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call attemps to delete a folder or filename off the end of a path string.
This call returns non-zero on success.<br><br></div></div><hr><divid='string_set_match_table_doc'style='margin-bottom: 1cm;'><divid='string_set_match_doc'><h4>§4.3.115: string_set_match_table</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool string_set_match_table(<divstyle='margin-left: 4mm;'>void *str_set,<br>int32_t item_size,<br>int32_t count,<br>String str,<br>int32_t *match_index<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str_set</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str_set parameter may be an array of any type.
It should point at the String in the first element of the array.</div></div></div><div><divstyle='font-weight: 600;'>count</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The item_size parameter should describe the "stride" from one String to the next, in other
words it should be the size of one element of the array.</div></div></div><div><divstyle='font-weight: 600;'>count</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The count parameter specifies the number of elements in the str_set array.</div></div></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter specifies the string to match against the str_set.</div></div></div><div><divstyle='font-weight: 600;'>match_index</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this call succeeds match_index is filled with the index into str_set where the match occurred.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call tries to see if str matches any of the strings in str_set. If there is a match the call
succeeds and returns non-zero. The matching rule is equivalent to the matching rule for match.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#match_doc'>match</a></div></div></div><hr><divid='string_set_match_doc'style='margin-bottom: 1cm;'><h4>§4.3.116: string_set_match</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>fstr_bool string_set_match(<divstyle='margin-left: 4mm;'>String *str_set,<br>int32_t count,<br>String str,<br>int32_t *match_index<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>str_set</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str_set parameter is an array of String structs specifying matchable strings.</div></div></div><div><divstyle='font-weight: 600;'>count</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The count parameter specifies the number of String structs in the str_set array.</div></div></div><div><divstyle='font-weight: 600;'>str</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The str parameter specifies the string to match against the str_set.</div></div></div><div><divstyle='font-weight: 600;'>match_index</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If this call succeeds match_index is filled with the index into str_set where the match occurred.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call tries to see if str matches any of the strings in str_set. If there is a match the call
succeeds and returns non-zero. The matching rule is equivalent to the matching rule for match.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#match_doc'>match</a></div></div><hr>
<h2id='section_lexer_library'>§5 Lexer Library</h2><h3>§5.1 Lexer Intro</h3><div>The 4cpp lexer system provides a polished, fast, flexible system that takes in C/C++ and outputs a tokenization of the text data. There are two API levels. One level is setup to let you easily get a tokenization of the file. This level manages memory for you with malloc to make it as fast as possible to start getting your tokens. The second level enables deep integration by allowing control over allocation, data chunking, and output rate control.<br><br>To use the quick setup API you simply include 4cpp_lexer.h and read the documentation at <ahref='#cpp_lex_file_doc'>cpp_lex_file</a>.<br><br>To use the the fancier API include 4cpp_lexer.h and read the documentation at <ahref='#cpp_lex_step_doc'>cpp_lex_step</a>. If you want to be absolutely sure you are not including malloc into your program you can define FCPP_FORBID_MALLOC before the include and the "step" API will continue to work.<br><br>There are a few more features in 4cpp that are not documented yet. You are free to try to use these, but I am not totally sure they are ready yet, and when they are they will be documented.</div><h3>§5.2 Lexer Function List</h3><ul><li><ahref='#cpp_get_token_doc'>cpp_get_token</a></li><li><ahref='#cpp_lex_step_doc'>cpp_lex_step</a></li><li><ahref='#cpp_lex_data_init_doc'>cpp_lex_data_init</a></li><li><ahref='#cpp_lex_data_temp_size_doc'>cpp_lex_data_temp_size</a></li><li><ahref='#cpp_lex_data_temp_read_doc'>cpp_lex_data_temp_read</a></li><li><ahref='#cpp_lex_data_new_temp_doc'>cpp_lex_data_new_temp</a></li><li><ahref='#cpp_make_token_array_doc'>cpp_make_token_array</a></li><li><ahref='#cpp_free_token_array_doc'>cpp_free_token_array</a></li><li><ahref='#cpp_resize_token_array_doc'>cpp_resize_token_array</a></li><li><ahref='#cpp_lex_file_doc'>cpp_lex_file</a></li></ul><h3>§5.3 Lexer Types List</h3><ul><li><ahref='#Cpp_Token_Type_doc'>Cpp_Token_Type</a></li><li><ahref='#Cpp_Token_doc'>Cpp_Token</a></li><li><ahref='#Cpp_Token_Flag_doc'>Cpp_Token_Flag</a></li><li><ahref='#Cpp_Token_Array_doc'>Cpp_Token_Array</a></li><li><ahref='#Cpp_Get_Token_Result_doc'>Cpp_Get_Token_Result</a></li><li><ahref='#Cpp_Lex_Data_doc'>Cpp_Lex_Data</a></li><li><ahref='#Cpp_Lex_Result_doc'>Cpp_Lex_Result</a></li></ul><h3>§5.4 Lexer Function Descriptions</h3><divid='cpp_get_token_doc'style='margin-bottom: 1cm;'><h4>§5.4.1: cpp_get_token</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>Cpp_Get_Token_Result cpp_get_token(<divstyle='margin-left: 4mm;'>Cpp_Token_Array *token_array_in,<br>int32_t pos<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>token_array</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The array of tokens from which to get a token.</div></div></div><div><divstyle='font-weight: 600;'>pos</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The position, measured in bytes, to get the token for.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>A Cpp_Get_Token_Result struct is returned containing the index
of a token and a flag indicating whether the pos is contained in the token
or in whitespace after the token.</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call performs a binary search over all of the tokens looking
for the token that contains the specified position. If the position
is in whitespace between the tokens, the returned token index is the
index of the token immediately before the provided position. The returned
index can be -1 if the position is before the first token.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Cpp_Get_Token_Result_doc'>Cpp_Get_Token_Result</a></div></div><hr><divid='cpp_lex_step_doc'style='margin-bottom: 1cm;'><h4>§5.4.2: cpp_lex_step</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>Cpp_Lex_Result cpp_lex_step(<divstyle='margin-left: 4mm;'>Cpp_Lex_Data *S_ptr,<br>char *chunk,<br>int32_t size,<br>int32_t full_size,<br>Cpp_Token_Array *token_array_out,<br>int32_t max_tokens_out<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>S_ptr</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The lexer state. Go to the Cpp_Lex_Data section to see how to initialize the state.</div></div></div><div><divstyle='font-weight: 600;'>chunk</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The first or next chunk of the file being lexed.</div></div></div><div><divstyle='font-weight: 600;'>size</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The number of bytes in the chunk including the null terminator if the chunk ends in a null terminator.
If the chunk ends in a null terminator the system will interpret it as the end of the file.</div></div></div><div><divstyle='font-weight: 600;'>full_size</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>If the final chunk is not null terminated this parameter should specify the length of the
file in bytes. To rely on an eventual null terminator use HAS_NULL_TERM for this parameter.</div></div></div><div><divstyle='font-weight: 600;'>token_array_out</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The token array structure that will receive the tokens output by the lexer.</div></div></div><div><divstyle='font-weight: 600;'>max_tokens_out</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The maximum number of tokens to be output to the token array. To rely on the
max built into the token array pass NO_OUT_LIMIT here.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call is the primary interface of the lexing system. It is quite general so it can be used in
a lot of different ways. I will explain the general rules first, and then give some examples of common
ways it might be used.<br><br>
First a lexing state, Cpp_Lex_Data, must be initialized. The file to lex must be read into N contiguous chunks
as the file being lexed.<br><br></div></div><hr><divid='cpp_lex_data_temp_size_doc'style='margin-bottom: 1cm;'><h4>§5.4.4: cpp_lex_data_temp_size</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t cpp_lex_data_temp_size(<divstyle='margin-left: 4mm;'>Cpp_Lex_Data *lex_data<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>lex_data</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The lex state from which to get the temporary buffer size.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call gets the current size of the temporary buffer in the lexer state so
that you can move to a new temporary buffer by copying the data over.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#cpp_lex_data_temp_read_doc'>cpp_lex_data_temp_read</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#cpp_lex_data_new_temp_doc'>cpp_lex_data_new_temp</a></div></div><hr><divid='cpp_lex_data_temp_read_doc'style='margin-bottom: 1cm;'><h4>§5.4.5: cpp_lex_data_temp_read</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void cpp_lex_data_temp_read(<divstyle='margin-left: 4mm;'>Cpp_Lex_Data *lex_data,<br>char *out_buffer<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>lex_data</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The lex state from which to read the temporary buffer.</div></div></div><div><divstyle='font-weight: 600;'>out_buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The buffer into which the contents of the temporary buffer will be written.
The size of the buffer must be at least the size as returned by cpp_lex_data_temp_size.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call reads the current contents of the temporary buffer.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#cpp_lex_data_temp_size_doc'>cpp_lex_data_temp_size</a></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#cpp_lex_data_new_temp_doc'>cpp_lex_data_new_temp</a></div></div><hr><divid='cpp_lex_data_new_temp_doc'style='margin-bottom: 1cm;'><h4>§5.4.6: cpp_lex_data_new_temp</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void cpp_lex_data_new_temp(<divstyle='margin-left: 4mm;'>Cpp_Lex_Data *lex_data,<br>char *new_buffer<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>lex_data</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The lex state that will receive the new temporary buffer.</div></div></div><div><divstyle='font-weight: 600;'>new_buffer</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The new temporary buffer that has the same contents as the old temporary buffer.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call can be used to set a new temporary buffer for the lex state. In cases where you want to
than the current size of the array the operation is ignored.</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>This call allocates a new memory chunk and moves the existing tokens in the array
over to the new chunk.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#cpp_make_token_array_doc'>cpp_make_token_array</a></div></div><hr><divid='cpp_lex_file_doc'style='margin-bottom: 1cm;'><h4>§5.4.10: cpp_lex_file</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void cpp_lex_file(<divstyle='margin-left: 4mm;'>char *data,<br>int32_t size,<br>Cpp_Token_Array *token_array_out<br></div>)</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div><divstyle='font-weight: 600;'>data</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The file data to be lexed in a single contiguous block.</div></div></div><div><divstyle='font-weight: 600;'>size</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The number of bytes in data.</div></div></div><div><divstyle='font-weight: 600;'>token_array_out</div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The token array where the output tokens will be pushed.
This token array must be previously allocated with cpp_make_token_array</div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Lexes an entire file and manages the interaction with the lexer system so that
parsing to determine the full nature of the token.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_AMPERSAND</span> = 48</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is an 'ambiguous' token type because it requires
parsing to determine the full nature of the token.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_TILDE</span> = 49</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is an 'ambiguous' token type because it requires
parsing to determine the full nature of the token.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_PLUS</span> = 50</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is an 'ambiguous' token type because it requires
parsing to determine the full nature of the token.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_MINUS</span> = 51</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is an 'ambiguous' token type because it requires
parsing to determine the full nature of the token.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_INCREMENT</span> = 52</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is an 'ambiguous' token type because it requires
parsing to determine the full nature of the token.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_DECREMENT</span> = 53</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This is an 'ambiguous' token type because it requires
parsing to determine the full nature of the token.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_SCOPE</span> = 54</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_POSTINC</span> = 55</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This type is for parser use, it is not output by the lexer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_POSTDEC</span> = 56</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This type is for parser use, it is not output by the lexer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_FUNC_STYLE_CAST</span> = 57</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This type is for parser use, it is not output by the lexer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_CPP_STYLE_CAST</span> = 58</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_CALL</span> = 59</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This type is for parser use, it is not output by the lexer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_INDEX</span> = 60</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This type is for parser use, it is not output by the lexer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_DOT</span> = 61</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_ARROW</span> = 62</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_PREINC</span> = 63</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This token is for parser use, it is not output by the lexer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_PREDEC</span> = 64</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This token is for parser use, it is not output by the lexer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_POSITIVE</span> = 65</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This token is for parser use, it is not output by the lexer.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TOKEN_NEGAITVE</span> = 66</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This token is for parser use, it is not output
It is the primary output of the lexing system.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>type</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The type field indicates the type of the token.
All tokens have a type no matter the circumstances.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>start</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The start field indicates the index of the first character
of this token's lexeme.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>size</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The size field indicates the number of bytes in this token's lexeme.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>state_flags</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The state_flags should not be used outside of the lexer's implementation.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>flags</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The flags field contains extra useful information about the token.<br><br></div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#Cpp_Token_Flag_doc'>Cpp_Token_Flag</a></div></div><hr><divid='Cpp_Token_Flag_doc'style='margin-bottom: 1cm;'><h4>§5.5.3: Cpp_Token_Flag</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Cpp_Token_Flag;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>The Cpp_Token_Flags are used to mark up tokens with additional information.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TFLAG_PP_DIRECTIVE</span> = 0x1</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Indicates that the token is a preprocessor directive.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TFLAG_PP_BODY</span> = 0x2</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Indicates that the token is on the line of a preprocessor directive.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TFLAG_MULTILINE</span> = 0x4</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Indicates that the token spans across multiple lines. This can show up
on line comments and string literals with back slash line continuation.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TFLAG_IS_OPERATOR</span> = 0x8</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Indicates that the token is some kind of operator or punctuation like braces.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>CPP_TFLAG_IS_KEYWORD</span> = 0x10</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>Indicates that the token is a keyword.<br><br></div></div></div></div><hr><divid='Cpp_Token_Array_doc'style='margin-bottom: 1cm;'><h4>§5.5.4: Cpp_Token_Array</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Cpp_Token_Array {<br><divstyle='margin-left: 8mm;'>Cpp_Token * tokens;<br>int32_t count;<br>int32_t max_count;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Cpp_Token_Array is used to bundle together the common elements
of a growing array of Cpp_Tokens. To initialize it the tokens field should
point to a block of memory with a size equal to max_count*sizeof(Cpp_Token)
and the count should be initialized to zero.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>tokens</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The tokens field points to the memory used to store the array of tokens.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>count</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The count field counts how many tokens in the array are currently used.<br><br></div></div></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>max_count</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The max_count field specifies the maximum size the count field may grow to before
the tokens array is out of space.<br><br></div></div></div></div><hr><divid='Cpp_Get_Token_Result_doc'style='margin-bottom: 1cm;'><h4>§5.5.5: Cpp_Get_Token_Result</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Cpp_Get_Token_Result {<br><divstyle='margin-left: 8mm;'>int32_t token_index;<br>int32_t in_whitespace;<br></div>};<br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Cpp_Get_Token_Result is the return result of the cpp_get_token call.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div><divstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>token_index</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>The token_index field indicates which token answers the query. To get the token from
after the result token.<br><br></div></div></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#cpp_get_token_doc'>cpp_get_token</a></div></div><hr><divid='Cpp_Lex_Data_doc'style='margin-bottom: 1cm;'><h4>§5.5.6: Cpp_Lex_Data</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Cpp_Lex_Data { /* non-public internals */ } ;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Cpp_Lex_Data represents the state of the lexer so that the system may be resumable
The internals of the lex state should not be treated as a part of the public API.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'><ahref='#cpp_lex_data_init_doc'>cpp_lex_data_init</a></div></div><hr><divid='Cpp_Lex_Result_doc'style='margin-bottom: 1cm;'><h4>§5.5.7: Cpp_Lex_Result</h4><divstyle='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Cpp_Lex_Result;</div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><divstyle='margin-left: 5mm; margin-right: 5mm;'>Cpp_Lex_Result is returned from the lexing engine to indicate why it stopped lexing.<br><br></div><divstyle='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>LexResult_Finished</span> = 0</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This indicates that the system got to the end of the file and will not accept more input.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>LexResult_NeedChunk</span> = 1</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This indicates that the system got to the end of an input chunk and is ready to receive the
next input chunk.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>LexResult_NeedTokenMemory</span> = 2</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This indicates that the output array ran out of space to store tokens and needs to be
replaced or expanded before continuing.<br><br></div></div></div><div><div><spanstyle='font-family: "Courier New", Courier, monospace; text-align: left;'><spanstyle='font-weight: 600;'>LexResult_HitTokenLimit</span> = 3</span></div><divstyle='margin-bottom: 6mm;'><divstyle='margin-left: 5mm; margin-right: 5mm;'>This indicates that the maximum number of output tokens as specified by the user was hit.<br><br></div></div></div></div><hr></div></body></html>
