ps
/
4coder
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4coder/4coder_API.html

3220 lines
270 KiB
HTML
Raw Normal View History

doc generator prototype
2016-06-24 19:33:37 +00:00
<html lang="en-US">
<head>
<title>4coder API Docs</title>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
<style>
basic function doc formatting
2016-06-27 19:45:15 +00:00
body { background: #FAFAFA; color: #0D0D0D; }
h1,h2,h3,h4 { color: #309030; margin: 0; }
upgraded string library
2016-07-06 19:18:10 +00:00
h2 { margin-top: 6mm; }
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
h3 { margin-top: 5mm; margin-bottom: 5mm; }
basic function doc formatting
2016-06-27 19:45:15 +00:00
h4 { font-size: 1.1em; }
a { color: #309030; text-decoration: none; }
improve the work-flow of jump to error a little more
2016-06-29 17:16:08 +00:00
a:visited { color: #A0C050; }
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
a:hover { background: #E0FFD0; }
ul { list-style: none; padding: 0; margin: 0; }
</style>
doc generator prototype
2016-06-24 19:33:37 +00:00
</head>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
<body>
standard build function fixed
2016-07-02 14:56:50 +00:00
<div style='font-family:Arial; margin: 0 auto; width: 800px; text-align: justify; line-height: 1.25;'>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
<h1 style='margin-top: 5mm; margin-bottom: 5mm;'>4coder API</h1>
upgraded string library
2016-07-06 19:18:10 +00:00
<h3 style='margin:0;'>Table of Contents</h3>
<ul>
<li><a href='#section_introduction'>&sect;1 Introduction</a></li><li><a href='#section_4coder_systems'>&sect;2 4coder Systems</a></li><li><a href='#section_types_and_functions'>&sect;3 Types and Functions</a></li><li><a href='#section_string_library'>&sect;4 String Library</a></li></ul>
<h2 id='section_introduction'>&sect;1 Introduction</h2>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
<div>
<p>
new word complete appears to work
2016-07-11 16:15:37 +00:00
This is the documentation for alpha 4.0.10 super! 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>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
<p>
standard build function fixed
2016-07-02 14:56:50 +00:00
If you have questions or discover errors please contact <span style='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 <span style='font-family: "Courier New", Courier, monospace; text-align: left;'>4coder.handmade.network</span></p>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
upgraded string library
2016-07-06 19:18:10 +00:00
<h2 id='section_4coder_systems'>&sect;2 4coder Systems</h2>
standard build function fixed
2016-07-02 14:56:50 +00:00
<div><i>
Coming Soon</i><div>
upgraded string library
2016-07-06 19:18:10 +00:00
<h2 id='section_types_and_functions'>&sect;3 Types and Functions</h2>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<h3>&sect;3.1 Function List</h3>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
<ul>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#exec_command_doc'>exec_command</a></li>
<li><a href='#exec_system_command_doc'>exec_system_command</a></li>
<li><a href='#clipboard_post_doc'>clipboard_post</a></li>
<li><a href='#clipboard_count_doc'>clipboard_count</a></li>
<li><a href='#clipboard_index_doc'>clipboard_index</a></li>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
<li><a href='#get_buffer_count_doc'>get_buffer_count</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#get_buffer_first_doc'>get_buffer_first</a></li>
<li><a href='#get_buffer_next_doc'>get_buffer_next</a></li>
<li><a href='#get_buffer_doc'>get_buffer</a></li>
<li><a href='#get_buffer_by_name_doc'>get_buffer_by_name</a></li>
<li><a href='#buffer_boundary_seek_doc'>buffer_boundary_seek</a></li>
<li><a href='#buffer_read_range_doc'>buffer_read_range</a></li>
<li><a href='#buffer_replace_range_doc'>buffer_replace_range</a></li>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<li><a href='#buffer_compute_cursor_doc'>buffer_compute_cursor</a></li>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<li><a href='#buffer_batch_edit_doc'>buffer_batch_edit</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#buffer_set_setting_doc'>buffer_set_setting</a></li>
<li><a href='#buffer_auto_indent_doc'>buffer_auto_indent</a></li>
<li><a href='#create_buffer_doc'>create_buffer</a></li>
<li><a href='#save_buffer_doc'>save_buffer</a></li>
<li><a href='#kill_buffer_doc'>kill_buffer</a></li>
<li><a href='#get_view_first_doc'>get_view_first</a></li>
<li><a href='#get_view_next_doc'>get_view_next</a></li>
<li><a href='#get_view_doc'>get_view</a></li>
<li><a href='#get_active_view_doc'>get_active_view</a></li>
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<li><a href='#open_view_doc'>open_view</a></li>
<li><a href='#close_view_doc'>close_view</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#set_active_view_doc'>set_active_view</a></li>
<li><a href='#view_set_setting_doc'>view_set_setting</a></li>
<li><a href='#view_set_split_proportion_doc'>view_set_split_proportion</a></li>
<li><a href='#view_compute_cursor_doc'>view_compute_cursor</a></li>
<li><a href='#view_set_cursor_doc'>view_set_cursor</a></li>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<li><a href='#view_set_scroll_doc'>view_set_scroll</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#view_set_mark_doc'>view_set_mark</a></li>
<li><a href='#view_set_highlight_doc'>view_set_highlight</a></li>
<li><a href='#view_set_buffer_doc'>view_set_buffer</a></li>
<li><a href='#view_post_fade_doc'>view_post_fade</a></li>
<li><a href='#get_user_input_doc'>get_user_input</a></li>
<li><a href='#get_command_input_doc'>get_command_input</a></li>
<li><a href='#get_mouse_state_doc'>get_mouse_state</a></li>
<li><a href='#start_query_bar_doc'>start_query_bar</a></li>
<li><a href='#end_query_bar_doc'>end_query_bar</a></li>
<li><a href='#print_message_doc'>print_message</a></li>
<li><a href='#change_theme_doc'>change_theme</a></li>
<li><a href='#change_font_doc'>change_font</a></li>
<li><a href='#set_theme_colors_doc'>set_theme_colors</a></li>
<li><a href='#get_theme_colors_doc'>get_theme_colors</a></li>
<li><a href='#directory_get_hot_doc'>directory_get_hot</a></li>
<li><a href='#get_file_list_doc'>get_file_list</a></li>
<li><a href='#free_file_list_doc'>free_file_list</a></li>
new word complete appears to work
2016-07-11 16:15:37 +00:00
<li><a href='#memory_allocate_doc'>memory_allocate</a></li>
<li><a href='#memory_set_protection_doc'>memory_set_protection</a></li>
<li><a href='#memory_free_doc'>memory_free</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#file_exists_doc'>file_exists</a></li>
<li><a href='#directory_cd_doc'>directory_cd</a></li>
<li><a href='#get_4ed_path_doc'>get_4ed_path</a></li>
<li><a href='#show_mouse_cursor_doc'>show_mouse_cursor</a></li>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</ul>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<h3>&sect;3.2 Type List</h3>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<ul>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<li><a href='#bool32_doc'>bool32</a></li>
<li><a href='#int_color_doc'>int_color</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#Key_Code_doc'>Key_Code</a></li>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<li><a href='#Buffer_ID_doc'>Buffer_ID</a></li>
<li><a href='#View_ID_doc'>View_ID</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#Key_Modifier_doc'>Key_Modifier</a></li>
<li><a href='#Command_ID_doc'>Command_ID</a></li>
<li><a href='#User_Input_Type_ID_doc'>User_Input_Type_ID</a></li>
<li><a href='#Event_Message_Type_ID_doc'>Event_Message_Type_ID</a></li>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<li><a href='#Buffer_Batch_Edit_Type_doc'>Buffer_Batch_Edit_Type</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#Buffer_Setting_ID_doc'>Buffer_Setting_ID</a></li>
<li><a href='#View_Setting_ID_doc'>View_Setting_ID</a></li>
<li><a href='#Mouse_Cursor_Show_Type_doc'>Mouse_Cursor_Show_Type</a></li>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<li><a href='#Buffer_Seek_Type_doc'>Buffer_Seek_Type</a></li>
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<li><a href='#View_Split_Position_doc'>View_Split_Position</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#Key_Modifier_Flag_doc'>Key_Modifier_Flag</a></li>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
<li><a href='#Memory_Protect_Flags_doc'>Memory_Protect_Flags</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#Buffer_Create_Flag_doc'>Buffer_Create_Flag</a></li>
<li><a href='#Buffer_Kill_Flag_doc'>Buffer_Kill_Flag</a></li>
<li><a href='#Access_Flag_doc'>Access_Flag</a></li>
<li><a href='#Seek_Boundary_Flag_doc'>Seek_Boundary_Flag</a></li>
<li><a href='#Command_Line_Input_Flag_doc'>Command_Line_Input_Flag</a></li>
<li><a href='#Auto_Indent_Flag_doc'>Auto_Indent_Flag</a></li>
<li><a href='#Set_Buffer_Flag_doc'>Set_Buffer_Flag</a></li>
<li><a href='#Input_Type_Flag_doc'>Input_Type_Flag</a></li>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<li><a href='#Generic_Command_doc'>Generic_Command</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#Key_Event_Data_doc'>Key_Event_Data</a></li>
<li><a href='#Mouse_State_doc'>Mouse_State</a></li>
<li><a href='#Range_doc'>Range</a></li>
<li><a href='#File_Info_doc'>File_Info</a></li>
<li><a href='#File_List_doc'>File_List</a></li>
<li><a href='#Buffer_Identifier_doc'>Buffer_Identifier</a></li>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<li><a href='#GUI_Scroll_Vars_doc'>GUI_Scroll_Vars</a></li>
<li><a href='#Full_Cursor_doc'>Full_Cursor</a></li>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<li><a href='#Partial_Cursor_doc'>Partial_Cursor</a></li>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<li><a href='#Buffer_Seek_doc'>Buffer_Seek</a></li>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<li><a href='#Buffer_Edit_doc'>Buffer_Edit</a></li>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<li><a href='#Buffer_Summary_doc'>Buffer_Summary</a></li>
<li><a href='#View_Summary_doc'>View_Summary</a></li>
<li><a href='#User_Input_doc'>User_Input</a></li>
<li><a href='#Query_Bar_doc'>Query_Bar</a></li>
<li><a href='#Event_Message_doc'>Event_Message</a></li>
<li><a href='#Theme_Color_doc'>Theme_Color</a></li>
</ul>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<h3>&sect;3.3 Function Descriptions</h3>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='exec_command_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.1: exec_command</h4>
<div style='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->exec_command(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Command_ID command_id<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>command_id</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The command_id parameter specifies which internal command to execute.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if command_id named a valid internal command.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A call to exec_command executes an internal command.
If command_id is invalid a warning is posted to *messages*.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Command_ID_doc'>Command_ID</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='exec_system_command_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.2: exec_system_command</h4>
<div style='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->exec_system_command(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Identifier buffer,<br>char *path,<br>int32_t path_len,<br>char *command,<br>int32_t command_len,<br>Command_Line_Input_Flag flags<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If the view parameter is non-null it specifies a view to display the command's output buffer.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>buffer</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The buffer the command will output to is specified by the buffer parameter.
See Buffer_Identifier for information on how this type specifies a buffer.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>path</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>path_len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The parameter path_len specifies the length of the path string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>command</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>command_len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The parameter command_len specifies the length of the command string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>flags</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>Flags for the behavior of the call are specified in the flags parameter.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
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.
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
If the view parameter is NULL, no view will switch to the output.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Identifier_doc'>Buffer_Identifier</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Command_Line_Input_Flag_doc'>Command_Line_Input_Flag</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='clipboard_post_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.3: clipboard_post</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>int32_t clipboard_id,<br>char *str,<br>int32_t len<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='font-weight: 600;'>clipboard_id</div>
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='font-weight: 600;'>str</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The len parameter specifies the length of the str string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Stores the string str in the clipboard initially with index 0.
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
Also reports the copy to the operating system, so that it may
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
be pasted into other applications.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#The_4coder_Clipboard_doc'>The_4coder_Clipboard</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='clipboard_count_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.4: clipboard_count</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>int32_t clipboard_id<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>clipboard_id</div>
<div style='margin-bottom: 6mm;'><div style='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 style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of items in the clipboard.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#The_4coder_Clipboard_doc'>The_4coder_Clipboard</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='clipboard_index_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.5: clipboard_index</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='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>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='font-weight: 600;'>clipboard_id</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='font-weight: 600;'>item_index</div>
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>out</div>
upgraded string library
2016-07-06 19:18:10 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides a buffer where the clipboard contents are written. This parameter may be NULL.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>len</div>
upgraded string library
2016-07-06 19:18:10 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the out buffer.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the size of the item associated with item_index.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#The_4coder_Clipboard_doc'>The_4coder_Clipboard</a></div></div><hr>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
<div id='get_buffer_count_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.6: get_buffer_count</h4>
<div style='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(
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
<div style='margin-left: 4mm;'>Application_Links *app<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_buffer_first_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.7: get_buffer_first</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>access</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the summary of the first buffer in a buffer loop.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call begins a loop across all the buffers.
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
If the buffer returned does not exist, the loop is finished.
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
Buffers should not be killed durring a buffer loop.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Summary_doc'>Buffer_Summary</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#get_buffer_next_doc'>get_buffer_next</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_buffer_next_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.8: get_buffer_next</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>Access_Flag access<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer</div>
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>access</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call steps a Buffer_Summary to the next buffer in the global buffer order.
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
The global buffer order is kept roughly in the order of most recently used to least recently used.
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
If the buffer outputted does not exist, the loop is finished.
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
Buffers should not be killed or created durring a buffer loop.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Summary_doc'>Buffer_Summary</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#get_buffer_first_doc'>get_buffer_first</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_buffer_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.9: get_buffer</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_ID buffer_id,<br>Access_Flag access<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer_id</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The parameter buffer_id specifies which buffer to try to get.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>access</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a summary that describes the indicated buffer if it exists and is accessible.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Summary_doc'>Buffer_Summary</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_ID_doc'>Buffer_ID</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_buffer_by_name_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.10: get_buffer_by_name</h4>
<div style='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_by_name(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len,<br>Access_Flag access<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>name</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The name parameter specifies the buffer name to try to get. The string need not be null terminated.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The len parameter specifies the length of the name string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>access</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a summary that describes the indicated buffer if it exists and is accessible.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Summary_doc'>Buffer_Summary</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='buffer_boundary_seek_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.11: buffer_boundary_seek</h4>
<div style='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_boundary_seek(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>int32_t start_pos,<br>bool32 seek_forward,<br>Seek_Boundary_Flag flags<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The buffer parameter specifies the buffer through which to seek.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>start_pos</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The beginning position of the seek is specified by start_pos measured in absolute position.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>seek_forward</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this parameter is non-zero it indicates that the seek should move foward through the buffer.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>flags</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field specifies the types of boundaries at which the seek should stop.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the absolute position where the seek stopped.
If the seek goes below 0 the returned value is -1.
If the seek goes past the end the returned value is the size of the buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Seek_Boundary_Flag_doc'>Seek_Boundary_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='buffer_read_range_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.12: buffer_read_range</h4>
<div style='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_range(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>int32_t start,<br>int32_t end,<br>char *out<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the buffer to read.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>start</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies absolute position of the first character in the read range.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>end</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the absolute position of the the character one past the end of the read range.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>out</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This paramter provides the output character buffer to fill with the result of the read.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the read succeeds.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>The output buffer must have a capacity of at least (end - start).
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
The output is not null terminated.
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
This call fails if the buffer does not exist,
or if the read range is not within the bounds of the buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='buffer_replace_range_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.13: buffer_replace_range</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='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>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the buffer to edit.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>start</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies absolute position of the first character in the replace range.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>end</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>str</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the str string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the replacement succeeds.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>If this call succeeds it deletes the range from start to end
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
and writes str in the same position. If end == start then
this call is equivalent to inserting the string at start.
If len == 0 this call is equivalent to deleteing the range
from start to end.
This call fails if the buffer does not exist, or if the replace
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
range is not within the bounds of the buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div id='buffer_compute_cursor_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.14: buffer_compute_cursor</h4>
<div style='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(
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>Buffer_Seek seek,<br>Partial_Cursor *cursor_out<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The buffer parameter specifies the buffer on which to run the cursor computation.</div></div>
</div>
<div>
<div style='font-weight: 600;'>seek</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The seek parameter specifies the target position for the seek.</div></div>
</div>
<div>
<div style='font-weight: 600;'>cursor_out</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>On success this struct is filled with the result of the seek.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Computes a Partial_Cursor for the given seek position with no side effects.
The seek position must be one of the types supported by Partial_Cursor. Those
types are absolute position and line,column position.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_doc'>Buffer_Seek</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Partial_Cursor_doc'>Partial_Cursor</a></div></div><hr>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<div id='buffer_batch_edit_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.15: buffer_batch_edit</h4>
<div style='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(
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<div style='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>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides all of the source string for the edits in the batch.</div></div>
</div>
<div>
<div style='font-weight: 600;'>str_len</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the str string.</div></div>
</div>
<div>
<div style='font-weight: 600;'>edits</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='font-weight: 600;'>edit_count</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the number of Buffer_Edit structs in edits.</div></div>
</div>
<div>
<div style='font-weight: 600;'>type</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This prameter specifies what type of batch edit to execute.</div></div>
</div>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the batch edit succeeds.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Edit_doc'>Buffer_Edit</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Batch_Edit_Type_doc'>Buffer_Batch_Edit_Type</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='buffer_set_setting_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.16: buffer_set_setting</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>Buffer_Setting_ID setting,<br>int32_t value<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The buffer parameter specifies the buffer on which to set a setting.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>setting</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The setting parameter identifies the setting that shall be changed.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>value</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The value parameter specifies the value to which the setting shall be changed.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Setting_ID_doc'>Buffer_Setting_ID</a></div></div><hr>
<div id='buffer_auto_indent_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.17: buffer_auto_indent</h4>
<div style='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_auto_indent(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>int32_t start,<br>int32_t end,<br>int32_t tab_width,<br>Auto_Indent_Flag flags<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The buffer specifies the buffer in which to apply auto indentation.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>start</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the absolute position of the start of the indentation range.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>end</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the absolute position of the end of the indentation range.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>tab_width</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The tab_width parameter specifies how many spaces should be used for one indentation in space mode.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>flags</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies behaviors for the indentation.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero when the call succeeds.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Applies the built in auto-indentation rule to the code in the range from
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
start to end by inserting spaces or tabs at the beginning of the lines.
If the buffer does not have lexing enabled or the lexing job has not
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
completed this function will fail.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Auto_Indent_Flag_doc'>Auto_Indent_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='create_buffer_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.18: create_buffer</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *filename,<br>int32_t filename_len,<br>Buffer_Create_Flag flags<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>filename</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>filename_len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The filename_len parameter spcifies the length of the filename string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>flags</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The flags parameter specifies behaviors for buffer creation.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the summary of the created buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Tries to create a new buffer and associate it to the given filename. If such a buffer already
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
exists the existing buffer is returned in the Buffer_Summary and no new buffer is created.
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
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
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
the filename does not correspond to a file on disk the buffer is created empty.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Summary_doc'>Buffer_Summary</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Create_Flag_doc'>Buffer_Create_Flag</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='save_buffer_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.19: save_buffer</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>char *filename,<br>int32_t filename_len,<br>uint32_t flags<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The buffer parameter specifies the buffer to save to a file.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>filename</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>filename_len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The filename_len parameter specifies the length of the filename string.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>flags</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter is not currently used and should be set to 0 for now.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='kill_buffer_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.20: kill_buffer</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Identifier buffer,<br>View_ID view_id,<br>Buffer_Kill_Flag flags<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>buffer</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The buffer parameter specifies the buffer to try to kill.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>view_id</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>flags</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The flags parameter specifies behaviors for the buffer kill.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Tries to kill the idenfied buffer. If the buffer is dirty and the "are you sure"
basic function doc formatting
2016-06-27 19:45:15 +00:00
dialogue needs to be displayed the provided view is used to show the dialogue.
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
If the view is not open the kill fails.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Kill_Flag_doc'>Buffer_Kill_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Identifier_doc'>Buffer_Identifier</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_view_first_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.21: get_view_first</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>access</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the summary of the first view in a view loop.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call begins a loop across all the open views.
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
If the View_Summary returned is a null summary, the loop is finished.
basic function doc formatting
2016-06-27 19:45:15 +00:00
Views should not be closed or opened durring a view loop.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#get_view_next_doc'>get_view_next</a></div></div><hr>
<div id='get_view_next_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.22: get_view_next</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Access_Flag access<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>access</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call steps a View_Summary to the next view in the global view order.
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
If the view outputted does not exist, the loop is finished.
basic function doc formatting
2016-06-27 19:45:15 +00:00
Views should not be closed or opened durring a view loop.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#get_view_first_doc'>get_view_first</a></div></div><hr>
<div id='get_view_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.23: get_view</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_ID view_id,<br>Access_Flag access<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view_id</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view_id specifies the view to try to get.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>access</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a summary that describes the indicated view if it is open and accessible.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_active_view_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.24: get_active_view</h4>
<div style='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_active_view(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>access</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The access parameter determines what levels of protection this call can access.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a summary that describes the active view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#set_active_view_doc'>set_active_view</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div></div><hr>
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<div id='open_view_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.25: open_view</h4>
<div style='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->open_view(
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view_location,<br>View_Split_Position position<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view_location</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view_location parameter specifies the view to split to open the new view.</div></div>
</div>
<div>
<div style='font-weight: 600;'>position</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The position parameter specifies how to split the view and where to place the new view.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>If this call succeeds it returns a View_Summary describing the newly created view, if it fails it
returns a null summary.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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
call will fail.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#View_Split_Position_doc'>View_Split_Position</a></div></div><hr>
<div id='close_view_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.26: close_view</h4>
<div style='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->close_view(
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies which view to close.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>If the given view is open and is not the last view, it will be closed.
If the given view is the active view, the next active view in the global
order of view will be made active.
If the given view is the last open view in the system, the call will fail.</div></div><hr>
start of new build system
2016-06-28 19:48:12 +00:00
<div id='set_active_view_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.27: set_active_view</h4>
<div style='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(
start of new build system
2016-06-28 19:48:12 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies which view to make active.</div></div>
start of new build system
2016-06-28 19:48:12 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>If the given view is open, it is set as the
start of new build system
2016-06-28 19:48:12 +00:00
active view, and takes subsequent commands and is returned
from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#get_active_view_doc'>get_active_view</a></div></div><hr>
moved cmdid_show_scrollbar/cmdid_hide_scrollbar to custom side
2016-06-29 18:38:58 +00:00
<div id='view_set_setting_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.28: view_set_setting</h4>
<div style='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_setting(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>View_Setting_ID setting,<br>int32_t value<br></div>)
moved cmdid_show_scrollbar/cmdid_hide_scrollbar to custom side
2016-06-29 18:38:58 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies the view on which to set a setting.</div></div>
moved cmdid_show_scrollbar/cmdid_hide_scrollbar to custom side
2016-06-29 18:38:58 +00:00
</div>
<div>
<div style='font-weight: 600;'>setting</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The setting parameter identifies the setting that shall be changed.</div></div>
moved cmdid_show_scrollbar/cmdid_hide_scrollbar to custom side
2016-06-29 18:38:58 +00:00
</div>
<div>
<div style='font-weight: 600;'>value</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The value parameter specifies the value to which the setting shall be changed.</div></div>
moved cmdid_show_scrollbar/cmdid_hide_scrollbar to custom side
2016-06-29 18:38:58 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#View_Setting_ID_doc'>View_Setting_ID</a></div></div><hr>
jump to error
2016-06-28 22:58:50 +00:00
<div id='view_set_split_proportion_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.29: view_set_split_proportion</h4>
<div style='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_split_proportion(
jump to error
2016-06-28 22:58:50 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>float t<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies which view shall have it's size adjusted.</div></div>
jump to error
2016-06-28 22:58:50 +00:00
</div>
<div>
<div style='font-weight: 600;'>t</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The t parameter specifies the proportion of the containing box that the view should occupy. t should be in [0,1].</div></div>
jump to error
2016-06-28 22:58:50 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='view_compute_cursor_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.30: view_compute_cursor</h4>
<div style='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_compute_cursor(
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Seek seek,<br>Full_Cursor *cursor_out<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies the view on which to run the cursor computation.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>seek</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The seek parameter specifies the target position for the seek.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>cursor_out</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>On success this struct is filled with the result of the seek.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Computes a Full_Cursor for the given seek position with no side effects.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_doc'>Buffer_Seek</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Full_Cursor_doc'>Full_Cursor</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='view_set_cursor_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.31: view_set_cursor</h4>
<div style='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_cursor(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Seek seek,<br>bool32 set_preferred_x<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies the view in which to set the cursor.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>seek</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The seek parameter specifies the target position for the seek.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>set_preferred_x</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this parameter is true the preferred x is updated to match the new cursor x.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call sets the the view's cursor position. set_preferred_x should usually be true
unless the change in cursor position is is a vertical motion that tries to keep the
cursor in the same column or x position.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_doc'>Buffer_Seek</a></div></div><hr>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div id='view_set_scroll_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.32: view_set_scroll</h4>
<div style='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_scroll(
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>GUI_Scroll_Vars scroll<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#GUI_Scroll_Vars_doc'>GUI_Scroll_Vars</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='view_set_mark_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.33: view_set_mark</h4>
<div style='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_mark(
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Seek seek<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies the view in which to set the mark.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>seek</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The seek parameter specifies the target position for the seek.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call sets the the view's mark position.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_doc'>Buffer_Seek</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='view_set_highlight_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.34: view_set_highlight</h4>
<div style='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_highlight(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>int32_t start,<br>int32_t end,<br>bool32 turn_on<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies the view in which to set the highlight.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>start</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the absolute position of the first character of the highlight range.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>end</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the absolute position of the character one past the end of the highlight range.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>turn_on</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter indicates whether the highlight is being turned on or off.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>The highlight is mutually exclusive to the cursor. When the turn_on parameter
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
is set to true the highlight will be shown and the cursor will be hidden. After
that either setting the with view_set_cursor or calling view_set_highlight and
basic function doc formatting
2016-06-27 19:45:15 +00:00
the turn_on set to false, will switch back to showing the cursor.</div></div><hr>
<div id='view_set_buffer_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.35: view_set_buffer</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_ID buffer_id,<br>Set_Buffer_Flag flags<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies the view in which to display the buffer.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>buffer_id</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The buffer_id parameter specifies which buffer to show in the view.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>flags</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The flags parameter specifies behaviors for setting the buffer.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>On success view_set_buffer sets the specified view's current buffer and
basic function doc formatting
2016-06-27 19:45:15 +00:00
cancels and dialogue shown in the view and displays the file.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Set_Buffer_Flag_doc'>Set_Buffer_Flag</a></div></div><hr>
<div id='view_post_fade_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.36: view_post_fade</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='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>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>view</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The view parameter specifies the view onto which the fade effect shall be posted.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>seconds</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the number of seconds the fade effect should last.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>start</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the absolute position of the first character of the fade range.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>end</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>color</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#int_color_doc'>int_color</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_user_input_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.37: get_user_input</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Input_Type_Flag get_type,<br>Input_Type_Flag abort_type<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>get_type</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The get_type parameter specifies the set of input types that should be returned.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>abort_type</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The get_type parameter specifies the set of input types that should trigger an abort signal.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a User_Input that describes a user input event.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call preempts the command. The command is resumed if either a get or abort condition
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
is met, or if another command is executed. If either the abort condition is met or another
command is executed an abort signal is returned. If an abort signal is ever returned the
command should finish execution without any more calls that preempt the command.
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
If a get condition is met the user input is returned.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Input_Type_Flag_doc'>Input_Type_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#User_Input_doc'>User_Input</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_command_input_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.38: get_command_input</h4>
<div style='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_command_input(
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the input that triggered the currently executing command.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#User_Input_doc'>User_Input</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_mouse_state_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.39: get_mouse_state</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>Mouse_State app->get_mouse_state(
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the current mouse state as of the beginning of the frame.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Mouse_State_doc'>Mouse_State</a></div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='start_query_bar_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.40: start_query_bar</h4>
<div style='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->start_query_bar(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Query_Bar *bar,<br>uint32_t flags<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>bar</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides a Query_Bar that should remain in valid memory
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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>flags</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter is not currently used and should be 0 for now.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='end_query_bar_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.41: end_query_bar</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Query_Bar *bar,<br>uint32_t flags<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>bar</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter should be a bar pointer of a currently active query bar.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>flags</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter is not currently used and should be 0 for now.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Stops showing the particular query bar specified by the bar parameter.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='print_message_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.42: print_message</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *str,<br>int32_t len<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter specifies the string to post to *messages*; it need not be null terminated.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The len parameter specifies the length of the str string.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call posts a string to the *messages* buffer.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='change_theme_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.43: change_theme</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>name</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The len parameter specifies the length of the name string.</div></div>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call changes 4coder's theme to one of the built in themes.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='change_font_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.44: change_font</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len<br></div>)
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>name</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The len parameter specifies the length of the name string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call changes 4coder's font to one of the built in fonts.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='set_theme_colors_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.45: set_theme_colors</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Theme_Color *colors,<br>int32_t count<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>colors</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The colors pointer provides an array of color structs pairing differet style tags to color codes.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>count</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The count parameter specifies the number of Theme_Color structs in the colors array.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>For each struct in the array, the slot in the main color pallet specified by the
struct's tag is set to the color code in the struct. If the tag value is invalid
no change is made to the color pallet.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_theme_colors_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.46: get_theme_colors</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Theme_Color *colors,<br>int32_t count<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>colors</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>an array of color structs listing style tags to get color values for</div></div>
</div>
<div>
<div style='font-weight: 600;'>count</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>the number of color structs in the colors array</div></div>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>For each struct in the array, the color field of the struct is filled with the
color from the slot in the main color pallet specified by the tag. If the tag
value is invalid the color is filled with black.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='directory_get_hot_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.47: directory_get_hot</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *out,<br>int32_t capacity<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>out</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides a character buffer that receives the 4coder 'hot directory'.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>capacity</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the maximum size to be output to the out buffer.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the size of the string written into the buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>4coder has a concept of a 'hot directory' which is the directory most recently
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
accessed in the GUI. Whenever the GUI is opened it shows the hot directory.
In the future this will be deprecated and eliminated in favor of more flexible
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
directories controlled on the custom side.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_file_list_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.48: get_file_list</h4>
<div style='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(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *dir,<br>int32_t len<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>dir</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter the length of the dir string.</div></div>
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a File_List struct containing pointers to the names of the files in
basic function doc formatting
2016-06-27 19:45:15 +00:00
the specified directory. The File_List returned should be passed to free_file_list
when it is no longer in use.</div></div><hr>
<div id='free_file_list_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.49: free_file_list</h4>
<div style='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(
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>File_List list<br></div>)
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>list</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides the file list to be freed.</div></div>
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>After this call the file list passed in should not be read or written to.</div></div><hr>
new word complete appears to work
2016-07-11 16:15:37 +00:00
<div id='memory_allocate_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.50: memory_allocate</h4>
<div style='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(
new word complete appears to work
2016-07-11 16:15:37 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>int32_t size<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div><hr>
<div id='memory_set_protection_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.51: memory_set_protection</h4>
<div style='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(
new word complete appears to work
2016-07-11 16:15:37 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>void *ptr,<br>int32_t size,<br>Memory_Protect_Flags flags<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div><hr>
<div id='memory_free_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.52: memory_free</h4>
<div style='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(
new word complete appears to work
2016-07-11 16:15:37 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>void *mem,<br>int32_t size<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='file_exists_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.53: file_exists</h4>
<div style='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(
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *filename,<br>int len<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>filename</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the full path to a file; it need not be null terminated.</div></div>
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the filename string.</div></div>
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if and only if the file exists.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='directory_cd_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.54: directory_cd</h4>
<div style='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(
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *dir,<br>int *len,<br>int capacity,<br>char *rel_path,<br>int rel_len<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>dir</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides a character buffer that stores a directory; it need not be null terminated.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the dir string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>capacity</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the maximum size of the dir string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>rel_path</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='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>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div>
<div style='font-weight: 600;'>rel_len</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the rel_path string.</div></div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the call succeeds.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call succeeds if the new directory exists and the it fits inside the
dir buffer. If the call succeeds the dir buffer is filled with the new
directory and len is overwritten with the length of the new string in the buffer.
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
For instance if dir contains "C:/Users/MySelf" and rel is "Documents" the buffer
will contain "C:/Users/MySelf/Documents" and len will contain the length of that
string. This call can also be used with rel set to ".." to traverse to parent
folders.</div></div><hr>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div id='get_4ed_path_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.55: get_4ed_path</h4>
<div style='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->get_4ed_path(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *out,<br>int32_t capacity<br></div>)
basic function doc formatting
2016-06-27 19:45:15 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>out</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides a character buffer that receives the path to the 4ed executable file.</div></div>
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
</div>
basic function doc formatting
2016-06-27 19:45:15 +00:00
<div>
<div style='font-weight: 600;'>capacity</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the maximum capacity of the out buffer.</div></div>
now generating API headers and docs solely from the implementation file, thus eliminating the declaration/definition duplication
2016-06-27 15:52:58 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div></div><hr>
added mouse suppression mode
2016-06-29 19:11:37 +00:00
<div id='show_mouse_cursor_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.3.56: show_mouse_cursor</h4>
<div style='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->show_mouse_cursor(
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 4mm;'>Application_Links *app,<br>Mouse_Cursor_Show_Type show<br></div>)
added mouse suppression mode
2016-06-29 19:11:37 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>show</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the new state of the mouse cursor.</div></div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Mouse_Cursor_Show_Type_doc'>Mouse_Cursor_Show_Type</a></div></div><hr>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<h3>&sect;3.4 Type Descriptions</h3>
<div id='bool32_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.1: bool32</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>bool32 is an alias name to signal that an integer parameter or field is for
true/false vales.</div></div><hr>
<div id='int_color_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.2: int_color</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='Key_Code_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.3: Key_Code</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
<div id='Buffer_ID_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.4: Buffer_ID</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
<div id='View_ID_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.5: View_ID</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>View_ID is used to name a 4coder view. Each view has a unique id in
the range [1,16].</div></div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='Key_Modifier_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.6: Key_Modifier</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Key_Modifier acts as an index for specifying modifiers in arrays.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_SHIFT_INDEX</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_CONTROL_INDEX</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_ALT_INDEX</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_CAPS_INDEX</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_HOLD_INDEX</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_INDEX_COUNT</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>MDFR_INDEX_COUNT is used to specify the number of modifiers supported.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Command_ID_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.7: Command_ID</h4>
<div style='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_ID;</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Command_ID is used as a name for commands implemented internally in 4coder.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_null</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_null is set aside to always be zero and is not associated with any command.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_undo</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_undo performs a standard undo behavior.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_redo</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_redo reperforms an edit that was undone.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_history_backward</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_history_backward performs a step backwards through the file history, which includes previously lost redo branches.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_history_forward</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_history_forward unperforms the previous cmdid_history_backward step if possib.e</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_interactive_new</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_interactive_new begins an interactive dialogue to create a new buffer.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_interactive_open</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_interactive_open begins an interactive dialogue to open a file into a buffer.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_save_as</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_save_as does not currently work and is likely to be removed rather that fixed.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_interactive_switch_buffer</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_interactive_switch_buffer begins an interactive dialogue to choose an open buffer to swap into the active view.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_interactive_kill_buffer</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_interactive_kill_buffer begins an interactive dialogue to choose an open buffer to kill.</div></div>
</div>
<div>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_reopen</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_reopen reloads the active buffer's associated file and discards the old buffer contents for the reloaded file.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_save</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_save saves the buffer's contents into the associated file.</div></div>
</div>
<div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_kill_buffer</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_kill_buffer tries to kill the active buffer.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_open_color_tweaker</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_open_color_tweaker opens the theme editing GUI.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_open_config</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_open_config opens the configuration menu.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_open_menu</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_open_menu opens the top level menu.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_open_debug</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>cmdid_open_debug opens the debug information viewer mode.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid_count</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='User_Input_Type_ID_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.8: User_Input_Type_ID</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum User_Input_Type_ID;</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>User_Input_Type_ID specifies a type of user input event.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>UserInputNone</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>UserInputNone indicates that no event has occurred.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>UserInputKey</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>UserInputKey indicates an event which can be described by a Key_Event_Data struct.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>UserInputMouse</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>UserInputMouse indicates an event which can be described by a Mouse_State struct.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Event_Message_Type_ID_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.9: Event_Message_Type_ID</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Event_Message_Type_ID;</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Event_Message_Type_ID is a part of an unfinished feature.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventMessage_NoMessage</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventMessage_OpenView</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventMessage_Frame</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventMessage_CloseView</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<div id='Buffer_Batch_Edit_Type_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.10: Buffer_Batch_Edit_Type</h4>
<div style='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>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Buffer_Batch_Edit_Type is a type of batch operation.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BatchEdit_Normal</span></span></div>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The BatchEdit_Normal operation is always correct but does the most work.</div></div>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BatchEdit_PreserveTokens</span></span></div>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The BatchEdit_PreserveTokens operation is one in which none of the edits add, delete, or change any tokens.
This usually applies when whitespace is being replaced with whitespace.</div></div>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
</div>
</div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='Buffer_Setting_ID_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.11: Buffer_Setting_ID</h4>
<div style='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_Setting_ID;</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Buffer_Setting_ID names a setting in a buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferSetting_Null</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>BufferSetting_Null is not a valid setting, it is reserved to detect errors.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferSetting_Lex</span></span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The BufferSetting_Lex setting is used to determine whether to store C++ tokens
from with the buffer.</div></div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferSetting_WrapLine</span></span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferSetting_MapID</span></span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferSetting_Eol</span></span></div>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The BufferSetting_Eol setting specifies how line ends should be saved to the backing file.
4coder casey updated
2016-07-05 13:30:07 +00:00
A 1 indicates dos endings "\r\n" and a 0 indicates nix endings "\n".</div></div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
</div>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferSetting_Unimportant</span></span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferSetting_ReadOnly</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The BufferSetting_ReadOnly setting marks a buffer so that it can only be returned from buffer
access calls that include an AccessProtected flag.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='View_Setting_ID_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.12: View_Setting_ID</h4>
<div style='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_Setting_ID;</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A View_Setting_ID names a setting in a view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ViewSetting_Null</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>ViewSetting_Null is not a valid setting, it is reserved to detect errors.</div></div>
</div>
<div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ViewSetting_WrapLine</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The ViewSetting_WrapLine setting determines whether the view applies line wrapping
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.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ViewSetting_ShowWhitespace</span></span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ViewSetting_ShowScrollbar</span></span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The ViewSetting_ShowScrollbar setting determines whether a scroll bar is
attached to a view in it's scrollable section.</div></div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Mouse_Cursor_Show_Type_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.13: Mouse_Cursor_Show_Type</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Mouse_Cursor_Show_Type value specifes a mode for 4coder to handle the mouse cursor.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MouseCursorShow_Never</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The MouseCursorShow_Never mode never shows the cursor.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MouseCursorShow_Always</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The MouseCursorShow_Never mode always shows the cursor.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<div id='Buffer_Seek_Type_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.14: Buffer_Seek_Type</h4>
<div style='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_Seek_Type;</div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>The Buffer_Seek_Type is is used in a Buffer_Seek to identify which
coordinates are suppose to be used for the seek.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>buffer_seek_pos</span></span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>buffer_seek_wrapped_xy</span></span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This value indicates xy positioning with wrapped lines where the x and y values are in pixels.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>buffer_seek_unwrapped_xy</span></span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This value indicates xy positioning with unwrapped lines where the x and y values are in pixels.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>buffer_seek_line_char</span></span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_doc'>Buffer_Seek</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<div id='View_Split_Position_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.15: View_Split_Position</h4>
<div style='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>
moved view manipulation to custom side
2016-07-05 01:36:30 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ViewSplit_Top</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This value indicates that the new view should be above the existing view.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ViewSplit_Bottom</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This value indicates that the new view should be below the existing view.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ViewSplit_Left</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This value indicates that the new view should be left of the existing view.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ViewSplit_Right</span></span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This value indicates that the new view should be right of the existing view.</div></div>
</div>
</div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='Key_Modifier_Flag_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.16: Key_Modifier_Flag</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Key_Modifier_Flag field is used to specify a specific state of modifiers.
Flags can be combined with bit or to specify a state with multiple modifiers.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_NONE</span> = 0x0</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>MDFR_NONE specifies that no modifiers are pressed.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_CTRL</span> = 0x1</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_ALT</span> = 0x2</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MDFR_SHIFT</span> = 0x4</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
<div id='Memory_Protect_Flags_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.17: Memory_Protect_Flags</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Memory_Protect_Flags;</div>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MemProtect_Read</span> = 0x1</span></div>
new word complete appears to work
2016-07-11 16:15:37 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MemProtect_Write</span> = 0x2</span></div>
new word complete appears to work
2016-07-11 16:15:37 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MemProtect_Execute</span> = 0x4</span></div>
new word complete appears to work
2016-07-11 16:15:37 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
move towards searching commands custom side and custom allocator
2016-07-10 05:49:11 +00:00
</div>
</div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='Buffer_Create_Flag_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.18: Buffer_Create_Flag</h4>
<div style='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_Create_Flag;</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Buffer_Create_Flag field specifies how a buffer should be created.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferCreate_Background</span> = 0x1</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>BufferCreate_Background is not currently implemented.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferCreate_AlwaysNew</span> = 0x2</span></div>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>When BufferCreate_AlwaysNew is set it indicates the buffer should be
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
cleared to empty even if it's associated file already has content.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Buffer_Kill_Flag_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.19: Buffer_Kill_Flag</h4>
<div style='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_Kill_Flag;</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Buffer_Kill_Flag field specifies how a buffer should be killed.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferKill_Background</span> = 0x1</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>BufferKill_Background is not currently implemented.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferKill_AlwaysKill</span> = 0x2</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>When BufferKill_AlwaysKill is set it indicates the buffer should be killed
without asking, even when the buffer is dirty.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Access_Flag_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.20: Access_Flag</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>AccessOpen</span> = 0x0</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>AccessProtected</span> = 0x1</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>AccessHidden</span> = 0x2</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>AccessAll</span> = 0xFF</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>AccessAll is a catchall access for cases where an access call should always
return an object no matter what it's protection flags are.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Seek_Boundary_Flag_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.21: Seek_Boundary_Flag</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BoundaryWhitespace</span> = 0x1</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BoundaryToken</span> = 0x2</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BoundaryAlphanumeric</span> = 0x4</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BoundaryCamelCase</span> = 0x8</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Command_Line_Input_Flag_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.22: Command_Line_Input_Flag</h4>
<div style='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_Input_Flag;</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Command_Line_Input_Flag field specifies the behavior of a call to a command line interface.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>CLI_OverlapWithConflict</span> = 0x1</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>CLI_AlwaysBindToView</span> = 0x2</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>CLI_CursorAtEnd</span> = 0x4</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Auto_Indent_Flag_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.23: Auto_Indent_Flag</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>An Auto_Indent_Flag field specifies the behavior of an auto indentation operation.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>AutoIndent_ClearLine</span> = 0x1</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>AutoIndent_UseTab</span> = 0x2</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Set_Buffer_Flag_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.24: Set_Buffer_Flag</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Set_Buffer_Flag field specifies the behavior of an operation that sets the buffer of a view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>SetBuffer_KeepOriginalGUI</span> = 0x1</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If SetBuffer_KeepOriginalGUI then when the file is set, the view will not switch to it
if some other GUI was currently up, otherwise any GUI that is up is closed and the view
switches to the file.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Input_Type_Flag_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.25: Input_Type_Flag</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Input_Type_Flag field specifies a set of input event types.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventOnAnyKey</span> = 0x1</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If EventOnAnyKey is set, all keyboard events are included in the set.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventOnEsc</span> = 0x2</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If EventOnEsc is set, any press of the escape key is included in the set.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventOnLeftButton</span> = 0x4</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If EventOnLeftButton is set, left clicks are included in the set.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventOnRightButton</span> = 0x8</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If EventOnRightButton is set, right clicks are included in the set.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventOnWheel</span> = 0x10</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If EventOnWheel is set, any wheel movement is included in the set.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventOnButton</span> = (EventOnLeftButton | EventOnRightButton | EventOnWheel)</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If EventOnButton is set, all mouse button events are included in the set.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventOnMouseMove</span> = 0x20</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This is not totally implemented yet.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventOnMouse</span> = (EventOnButton | EventOnMouseMove)</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This is not totally implemented yet.</div></div>
</div>
<div>
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventAll</span> = 0xFF</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>EventAll is a catch all name for including all possible events in the set.</div></div>
</div>
</div><hr>
<div id='Generic_Command_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.26: Generic_Command</h4>
<div style='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>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-left: 8mm;'>
Command_ID cmdid;<br>
Custom_Command_Function * command;<br>
</div>
};<br>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cmdid</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>command</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this Generic_Command does not represent an internal command the command
field is the pointer to the custom command..</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Key_Event_Data_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.27: Key_Event_Data</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Key_Event_Data {<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
Key_Code keycode;<br>
Key_Code character;<br>
Key_Code character_no_caps_lock;<br>
char modifiers[MDFR_INDEX_COUNT];<br>
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Key_Event_Data describes a key event, including the
translation to a character, the translation to
a character ignoring the state of caps lock, and
an array of all the modifiers that were pressed
at the time of the event.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>keycode</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field is the raw keycode which is always non-zero in valid key events.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>character</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field is the keycode after translation to a character, this is 0 if there is no translation.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>character_no_caps_lock</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>modifiers</span></div>
<div style='margin-bottom: 6mm;'><div style='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
modifier was held, and a 0 indicates that it was not held.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Mouse_State_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.28: Mouse_State</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Mouse_State {<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
char l;<br>
char r;<br>
char press_l;<br>
char press_r;<br>
char release_l;<br>
char release_r;<br>
char wheel;<br>
char out_of_window;<br>
int x;<br>
int y;<br>
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Mouse_State describes an entire mouse state complete with the position,
left and right button states, the wheel state, and whether or not the
mouse if in the window.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>l</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the left button is held.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>r</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the right button is held.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>press_l</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the left button was pressed this frame.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>press_r</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the right button was pressed this frame.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>release_l</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the left button was released this frame.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>release_r</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the right button was released this frame.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>wheel</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>out_of_window</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the mouse is outside of the window.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>x</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>y</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Range_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.29: Range</h4>
<div style='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>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
struct {<br>
<div style='margin-left: 8mm;'>
int min;<br>
int max;<br>
</div>
};<br>
struct {<br>
<div style='margin-left: 8mm;'>
int start;<br>
int end;<br>
</div>
};<br>
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Range describes an integer range typically used for ranges within a buffer.
Ranges tend are usually not passed as a Range struct into the API, but this
struct is used to return ranges.
Throughout the API ranges are thought of in the form [min,max</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>min</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This is the smaller value in the range, it is also the 'start'.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>max</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This is the larger value in the range, it is also the 'end'.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>start</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This is the start of the range, it is also the 'min'.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>end</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This is the end of the range, it is also the 'max'.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='File_Info_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.30: File_Info</h4>
<div style='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>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
char * filename;<br>
int filename_len;<br>
int folder;<br>
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>File_Info describes the name and type of a file.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>filename</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field is a null terminated string specifying the name of the file.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>filename_len</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field specifies the length of the filename string not counting the null terminator.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>folder</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field indicates that the description is for a folder not a file.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#File_List_doc'>File_List</a></div></div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='File_List_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.31: File_List</h4>
<div style='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>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
void * block;<br>
File_Info * infos;<br>
int count;<br>
int block_size;<br>
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>File_List is a list of File_Info structs.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>block</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field is for inernal use.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>infos</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field is an array of File_Info structs.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>count</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field specifies the number of struts in the info array.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>block_size</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field is for internal use.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Buffer_Identifier_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.32: Buffer_Identifier</h4>
<div style='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_Identifier {<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
char * name;<br>
int name_len;<br>
int id;<br>
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Buffer_Identifier acts as a loosely typed description of a buffer that
can either be a name or an id. If the</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>name</span></div>
standard build function fixed
2016-07-02 14:56:50 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field is the name of the buffer; it need not be null terminated.
If id is specified this pointer should be NULL.</div></div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>name_len</span></div>
standard build function fixed
2016-07-02 14:56:50 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field specifies the length of the name string.</div></div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>id</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field is the id of the buffer. If name is specified this should be 0.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<div id='GUI_Scroll_Vars_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.33: GUI_Scroll_Vars</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct GUI_Scroll_Vars {<br>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<div style='margin-left: 8mm;'>
float scroll_y;<br>
int32_t target_y;<br>
int32_t prev_target_y;<br>
float scroll_x;<br>
int32_t target_x;<br>
int32_t prev_target_x;<br>
</div>
};<br>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This struct is a part of an incomplete feature.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>scroll_y</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>target_y</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>prev_target_y</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>scroll_x</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>target_x</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>prev_target_x</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
</div>
</div><hr>
<div id='Full_Cursor_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.34: Full_Cursor</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Full_Cursor {<br>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<div style='margin-left: 8mm;'>
int32_t pos;<br>
int32_t line;<br>
int32_t character;<br>
float unwrapped_x;<br>
float unwrapped_y;<br>
float wrapped_x;<br>
float wrapped_y;<br>
</div>
};<br>
</div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Full_Cursor describes the position of a cursor in every buffer
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
coordinate system supported by 4coder. This cursor type requires that
the buffer is associated with a view to give the x/y values meaning.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>pos</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the cursor's position in absolute positioning.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>line</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the number of the line where the cursor is located. This field is one based.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>character</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the number of the column where the cursor is located. This field is one based.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>unwrapped_x</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the x position measured with unwrapped lines.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>unwrapped_y</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the y position measured with unwrapped lines.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>wrapped_x</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the x position measured with wrapped lines.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>wrapped_y</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the y position measured with wrapped lines.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div id='Partial_Cursor_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.35: Partial_Cursor</h4>
<div style='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>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-left: 8mm;'>
int32_t pos;<br>
int32_t line;<br>
int32_t character;<br>
</div>
};<br>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Partial_Cursor describes the position of a cursor in all of
the coordinate systems that a invariant to the View. In other words
the coordinate systems available here can be used on a buffer that is
not currently associated with a View.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>pos</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the cursor's position in absolute positioning.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>line</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the number of the line where the cursor is located. This field is one based.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>character</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field contains the number of the column where the cursor is located. This field is one based.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<div id='Buffer_Seek_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.36: Buffer_Seek</h4>
<div style='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>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<div style='margin-left: 8mm;'>
Buffer_Seek_Type type;<br>
union {<br>
<div style='margin-left: 8mm;'>
struct {<br>
<div style='margin-left: 8mm;'>
int32_t pos;<br>
</div>
};<br>
struct {<br>
<div style='margin-left: 8mm;'>
bool32 round_down;<br>
float x;<br>
float y;<br>
</div>
};<br>
struct {<br>
<div style='margin-left: 8mm;'>
int32_t line;<br>
int32_t character;<br>
</div>
};<br>
</div>
};<br>
</div>
};<br>
</div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>type</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The type field determines the coordinate system of the seek operation.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>pos</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The pos field specified the pos when the seek is in absolute position.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>round_down</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='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
and keeping the preferred x.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>x</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The x coordinate for xy type seeks.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>y</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The y coordinate for xy type seeks.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>line</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The line number of a line-character type seek.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>character</span></div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The character number of a line-character type seek.</div></div>
new method of tracking previous file locations
2016-07-02 22:59:16 +00:00
</div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_Type_doc'>Buffer_Seek_Type</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<div id='Buffer_Edit_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.37: Buffer_Edit</h4>
<div style='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_Edit {<br>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<div style='margin-left: 8mm;'>
int32_t str_start;<br>
int32_t len;<br>
int32_t start;<br>
int32_t end;<br>
</div>
};<br>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Buffer_Edit describes a range of a buffer and string to replace that range.
A Buffer_Edit has to be paired with a string that contains the actual text that
will be replaced into the buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>str_start</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str_start field specifies the first character in the accompanying string that corresponds with this edit.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>len</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The len field specifies the length of the string being written into the buffer.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>start</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start field specifies the start of the range in the buffer to replace in absolute position.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>end</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
</div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='Buffer_Summary_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.38: Buffer_Summary</h4>
<div style='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>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
bool32 exists;<br>
bool32 ready;<br>
int32_t buffer_id;<br>
Access_Flag lock_flags;<br>
int32_t size;<br>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
int32_t line_count;<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
char * file_name;<br>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
int32_t file_name_len;<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
char * buffer_name;<br>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
int32_t buffer_name_len;<br>
bool32 is_lexed;<br>
int32_t map_id;<br>
remove file's font id
2016-07-04 20:40:57 +00:00
bool32 unwrapped_lines;<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Buffer_Summary acts as a handle to a buffer and describes the state of the buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>exists</span></div>
<div style='margin-bottom: 6mm;'><div style='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".</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ready</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field indicates whether the buffer has finished loading.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>buffer_id</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>lock_flags</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field contains flags describing the protection status of the buffer.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>size</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the size of the text in the buffer.</div></div>
</div>
<div>
moving towards batch edits in the custom API
2016-07-08 21:47:37 +00:00
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>line_count</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the number of lines in the buffer.</div></div>
</div>
<div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>file_name</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the file name associated to this buffer.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>file_name_len</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field specifies the length of the file_name string.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>buffer_name</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the name of the buffer.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>buffer_name_len</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field specifies the length of the buffer_name string.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>is_lexed</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field indicates whether the buffer is set to lex tokens.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>map_id</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
remove file's font id
2016-07-04 20:40:57 +00:00
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>unwrapped_lines</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field indicates whether the buffer 'prefers' wrapped lines.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div></div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='View_Summary_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.39: View_Summary</h4>
<div style='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>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
bool32 exists;<br>
int32_t view_id;<br>
int32_t buffer_id;<br>
Access_Flag lock_flags;<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
Full_Cursor cursor;<br>
Full_Cursor mark;<br>
float preferred_x;<br>
float line_height;<br>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
bool32 unwrapped_lines;<br>
bool32 show_whitespace;<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
i32_Rect file_region;<br>
GUI_Scroll_Vars scroll_vars;<br>
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>View_Summary acts as a handle to a view and describes the state of the view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>exists</span></div>
<div style='margin-bottom: 6mm;'><div style='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".</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>view_id</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>buffer_id</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, and this view looks at a buffer, this is the id of the buffer.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>lock_flags</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field contains flags describing the protection status of the view.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>cursor</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this describes the position of the cursor.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>mark</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this describes the position of the mark.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>preferred_x</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this is the x position that is maintained in vertical navigation.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>line_height</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this specifies the height of a line rendered in the view.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>unwrapped_lines</span></div>
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>show_whitespace</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this indicates that the view is set to highlight white space.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>file_region</span></div>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-bottom: 6mm;'><div style='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.</div></div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>scroll_vars</span></div>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this describes the scrolling position inside the view.</div></div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
</div>
search all, and jump to location with return appears to be working
2016-07-12 18:20:06 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Full_Cursor_doc'>Full_Cursor</a></div></div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='User_Input_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.40: User_Input</h4>
<div style='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>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
User_Input_Type_ID type;<br>
bool32 abort;<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
union {<br>
<div style='margin-left: 8mm;'>
Key_Event_Data key;<br>
Mouse_State mouse;<br>
</div>
};<br>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
Generic_Command command;<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>User_Input describes a user input event which can be either a key press or mouse event.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>type</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field specifies whether the event was a key press or mouse event.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>abort</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field indicates that an abort event has occurred and the command needs to shut down.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>key</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field describes a key press event.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>mouse</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This field describes a mouse input event.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>command</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this event would trigger a command, this field specifies what the command would be.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#User_Input_Type_ID_doc'>User_Input_Type_ID</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Generic_Command_doc'>Generic_Command</a></div></div><hr>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div id='Query_Bar_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.41: Query_Bar</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Query_Bar {<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
String prompt;<br>
String string;<br>
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Query_Bar is a struct used to store information in the user's control
that will be displayed as a drop down bar durring an interactive command.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>prompt</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This specifies the prompt portion of the drop down bar.</div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>string</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This specifies the main string portion of the drop down bar.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Event_Message_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.42: Event_Message</h4>
<div style='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>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
int type;<br>
</div>
};<br>
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This feature is not implemented.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>type</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This feature is not implemented.</div></div>
</div>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div><hr>
<div id='Theme_Color_doc' style='margin-bottom: 1cm;'>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<h4>&sect;3.4.43: Theme_Color</h4>
<div style='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>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
<div style='margin-left: 8mm;'>
Style_Tag tag;<br>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
int_color color;<br>
switched over to new 4coder_types.h, wrote docs
2016-07-01 05:42:19 +00:00
</div>
};<br>
added mouse suppression mode
2016-06-29 19:11:37 +00:00
</div>
doc rewrites into full sentences.
2016-07-02 14:15:15 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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 .</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>tag</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div>
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>color</span></div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Style_Tag_doc'>Style_Tag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#int_color_doc'>int_color</a></div></div><hr>
upgraded string library
2016-07-06 19:18:10 +00:00
<h2 id='section_string_library'>&sect;4 String Library</h2>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<h3>&sect;4.1 String Intro</h3>
<ul>
<div><i>
Coming Soon</i><div>
<h3>&sect;4.2 String Function List</h3>
upgraded string library
2016-07-06 19:18:10 +00:00
<ul>
<li><a href='#char_is_slash_str_doc'>char_is_slash</a></li>
<li><a href='#char_to_upper_str_doc'>char_to_upper</a></li>
<li><a href='#char_to_lower_str_doc'>char_to_lower</a></li>
<li><a href='#char_is_whitespace_str_doc'>char_is_whitespace</a></li>
<li><a href='#char_is_alpha_numeric_str_doc'>char_is_alpha_numeric</a></li>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<li><a href='#char_is_alpha_numeric_true_str_doc'>char_is_alpha_numeric_true</a></li>
upgraded string library
2016-07-06 19:18:10 +00:00
<li><a href='#char_is_alpha_str_doc'>char_is_alpha</a></li>
<li><a href='#char_is_alpha_true_str_doc'>char_is_alpha_true</a></li>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<li><a href='#char_is_hex_str_doc'>char_is_hex</a></li>
<li><a href='#char_is_numeric_str_doc'>char_is_numeric</a></li>
upgraded string library
2016-07-06 19:18:10 +00:00
<li><a href='#string_zero_str_doc'>string_zero</a></li>
<li><a href='#make_string_str_doc'>make_string</a></li>
<li><a href='#make_lit_string_str_doc'>make_lit_string</a></li>
<li><a href='#make_fixed_width_string_str_doc'>make_fixed_width_string</a></li>
<li><a href='#expand_str_str_doc'>expand_str</a></li>
<li><a href='#str_size_str_doc'>str_size</a></li>
<li><a href='#make_string_slowly_str_doc'>make_string_slowly</a></li>
<li><a href='#substr_str_doc'>substr</a></li>
<li><a href='#skip_whitespace_str_doc'>skip_whitespace</a></li>
<li><a href='#chop_whitespace_str_doc'>chop_whitespace</a></li>
<li><a href='#skip_chop_whitespace_str_doc'>skip_chop_whitespace</a></li>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<li><a href='#tailstr_str_doc'>tailstr</a></li>
upgraded string library
2016-07-06 19:18:10 +00:00
<li><a href='#match_str_doc'>match</a></li>
<li><a href='#match_part_str_doc'>match_part</a></li>
<li><a href='#match_insensitive_str_doc'>match_insensitive</a></li>
<li><a href='#match_part_insensitive_str_doc'>match_part_insensitive</a></li>
<li><a href='#compare_str_doc'>compare</a></li>
<li><a href='#find_str_doc'>find</a></li>
<li><a href='#find_substr_str_doc'>find_substr</a></li>
<li><a href='#rfind_substr_str_doc'>rfind_substr</a></li>
<li><a href='#find_substr_insensitive_str_doc'>find_substr_insensitive</a></li>
<li><a href='#has_substr_str_doc'>has_substr</a></li>
<li><a href='#has_substr_insensitive_str_doc'>has_substr_insensitive</a></li>
<li><a href='#copy_fast_unsafe_str_doc'>copy_fast_unsafe</a></li>
<li><a href='#copy_checked_str_doc'>copy_checked</a></li>
<li><a href='#copy_partial_str_doc'>copy_partial</a></li>
<li><a href='#copy_str_doc'>copy</a></li>
<li><a href='#append_checked_str_doc'>append_checked</a></li>
<li><a href='#append_partial_str_doc'>append_partial</a></li>
<li><a href='#append_str_doc'>append</a></li>
<li><a href='#terminate_with_null_str_doc'>terminate_with_null</a></li>
<li><a href='#append_padding_str_doc'>append_padding</a></li>
<li><a href='#replace_char_str_doc'>replace_char</a></li>
<li><a href='#int_to_str_size_str_doc'>int_to_str_size</a></li>
<li><a href='#int_to_str_str_doc'>int_to_str</a></li>
<li><a href='#append_int_to_str_str_doc'>append_int_to_str</a></li>
<li><a href='#u64_to_str_size_str_doc'>u64_to_str_size</a></li>
<li><a href='#u64_to_str_str_doc'>u64_to_str</a></li>
<li><a href='#append_u64_to_str_str_doc'>append_u64_to_str</a></li>
<li><a href='#float_to_str_size_str_doc'>float_to_str_size</a></li>
<li><a href='#append_float_to_str_str_doc'>append_float_to_str</a></li>
<li><a href='#float_to_str_str_doc'>float_to_str</a></li>
<li><a href='#str_to_int_str_doc'>str_to_int</a></li>
<li><a href='#hexchar_to_int_str_doc'>hexchar_to_int</a></li>
<li><a href='#int_to_hexchar_str_doc'>int_to_hexchar</a></li>
<li><a href='#hexstr_to_int_str_doc'>hexstr_to_int</a></li>
<li><a href='#color_to_hexstr_str_doc'>color_to_hexstr</a></li>
<li><a href='#hexstr_to_color_str_doc'>hexstr_to_color</a></li>
<li><a href='#reverse_seek_slash_str_doc'>reverse_seek_slash</a></li>
<li><a href='#front_of_directory_str_doc'>front_of_directory</a></li>
<li><a href='#path_of_directory_str_doc'>path_of_directory</a></li>
<li><a href='#set_last_folder_str_doc'>set_last_folder</a></li>
<li><a href='#file_extension_str_doc'>file_extension</a></li>
<li><a href='#remove_last_folder_str_doc'>remove_last_folder</a></li>
<li><a href='#string_set_match_str_doc'>string_set_match</a></li>
</ul>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<h3>&sect;4.3 String Function Descriptions</h3>
upgraded string library
2016-07-06 19:18:10 +00:00
<ul>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_is_slash_str_doc'><h4>&sect;4.3.1: char_is_slash</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool char_is_slash(
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if c is \ or /.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_to_upper_str_doc'><h4>&sect;4.3.2: char_to_upper</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
char char_to_upper(
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>If c is a lowercase letter this call returns the uppercase equivalent, otherwise it returns c.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_to_lower_str_doc'><h4>&sect;4.3.3: char_to_lower</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
char char_to_lower(
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>If c is an uppercase letter this call returns the lowercase equivalent, otherwise it returns c.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_is_whitespace_str_doc'><h4>&sect;4.3.4: char_is_whitespace</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool char_is_whitespace(
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if c is whitespace.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_is_alpha_numeric_str_doc'><h4>&sect;4.3.5: char_is_alpha_numeric</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool char_is_alpha_numeric(
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if c is any alphanumeric character including underscore.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_is_alpha_numeric_true_str_doc'><h4>&sect;4.3.6: char_is_alpha_numeric_true</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
fstr_bool char_is_alpha_numeric_true(
upgraded string library
2016-07-06 19:18:10 +00:00
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if c is any alphanumeric character no including underscore.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_is_alpha_str_doc'><h4>&sect;4.3.7: char_is_alpha</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
fstr_bool char_is_alpha(
upgraded string library
2016-07-06 19:18:10 +00:00
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if c is any alphabetic character including underscore.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_is_alpha_true_str_doc'><h4>&sect;4.3.8: char_is_alpha_true</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
fstr_bool char_is_alpha_true(
upgraded string library
2016-07-06 19:18:10 +00:00
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if c is any alphabetic character.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_is_hex_str_doc'><h4>&sect;4.3.9: char_is_hex</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
fstr_bool char_is_hex(
upgraded string library
2016-07-06 19:18:10 +00:00
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if c is any valid hexadecimal digit.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='char_is_numeric_str_doc'><h4>&sect;4.3.10: char_is_numeric</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
fstr_bool char_is_numeric(
upgraded string library
2016-07-06 19:18:10 +00:00
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if c is any valid decimal digit.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='string_zero_str_doc'><h4>&sect;4.3.11: string_zero</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String string_zero(
<div style='margin-left: 4mm;'><br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a String struct of zeroed members.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='make_string_str_doc'><h4>&sect;4.3.12: make_string</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String make_string(
<div style='margin-left: 4mm;'>void *str,<br>int32_t size,<br>int32_t mem_size<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides the of memory with which the string shall operate.</div></div>
</div>
<div>
<div style='font-weight: 600;'>size</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The size parameter expresses the initial size of the string.
If the memory does not already contain a useful string this should be zero.</div></div>
</div>
<div>
<div style='font-weight: 600;'>mem_size</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The mem_size parameter expresses the full size of the memory provided by str.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the String created from the parameters.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.13: make_string</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String make_string(
<div style='margin-left: 4mm;'>void *str,<br>int32_t size<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides the of memory with which the string shall operate.</div></div>
</div>
<div>
<div style='font-weight: 600;'>size</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The size parameter expresses the initial size of the string.
If the memory does not already contain a useful string this should be zero. Since this version
does not specify the size of the memory it is also assumed that this size is the maximum size
of the memory.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the String created from the parameters.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='make_lit_string_str_doc'><h4>&sect;4.3.14: make_lit_string</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
#define make_lit_string(s)</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='make_fixed_width_string_str_doc'><h4>&sect;4.3.15: make_fixed_width_string</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
#define make_fixed_width_string(s)</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='expand_str_str_doc'><h4>&sect;4.3.16: expand_str</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
#define expand_str(s)</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This macro is a helper for any calls that take a char*,int pair to specify a
string. This macro expands to both of those parameters from one String struct.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='str_size_str_doc'><h4>&sect;4.3.17: str_size</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t str_size(
<div style='margin-left: 4mm;'>char *str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of bytes before a null terminator starting at str.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='make_string_slowly_str_doc'><h4>&sect;4.3.18: make_string_slowly</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String make_string_slowly(
<div style='margin-left: 4mm;'>void *str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='substr_str_doc'><h4>&sect;4.3.19: substr</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String substr(
<div style='margin-left: 4mm;'>String str,<br>int32_t start<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call creates a substring of str that starts with an offset from str's base.
The new string uses the same underlying memory so both strings will see changes.
Usually strings created this way should only go through immutable calls.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.20: substr</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String substr(
<div style='margin-left: 4mm;'>String str,<br>int32_t start,<br>int32_t size<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call creates a substring of str that starts with an offset from str's base,
and has a fixed size. The new string uses the same underlying memory so both strings
will see changes. Usually strings created this way should only go through immutable calls.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='skip_whitespace_str_doc'><h4>&sect;4.3.21: skip_whitespace</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String skip_whitespace(
<div style='margin-left: 4mm;'>String str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call creates a substring that starts with the first non-whitespace character of str.
Like other substr calls, the new string uses the underlying memory and so should usually be
considered immutable.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#substr_doc'>substr</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='chop_whitespace_str_doc'><h4>&sect;4.3.22: chop_whitespace</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String chop_whitespace(
<div style='margin-left: 4mm;'>String str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call creates a substring that ends with the last non-whitespace character of str.
Like other substr calls, the new string uses the underlying memory and so should usually be
considered immutable.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#substr_doc'>substr</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='skip_chop_whitespace_str_doc'><h4>&sect;4.3.23: skip_chop_whitespace</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String skip_chop_whitespace(
<div style='margin-left: 4mm;'>String str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call is equivalent to calling skip_whitespace and chop_whitespace together.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#skip_whitespace_doc'>skip_whitespace</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#chop_whitespace_doc'>chop_whitespace</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='tailstr_str_doc'><h4>&sect;4.3.24: tailstr</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
String tailstr(
<div style='margin-left: 4mm;'>String str<br></div>)
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns an empty String with underlying memory taken from
the portion of str's memory that is not used.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='match_str_doc'><h4>&sect;4.3.25: match</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match(
<div style='margin-left: 4mm;'>char *a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.26: match</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match(
<div style='margin-left: 4mm;'>String a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.27: match</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match(
<div style='margin-left: 4mm;'>char *a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.28: match</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match(
<div style='margin-left: 4mm;'>String a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='match_part_str_doc'><h4>&sect;4.3.29: match_part</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part(
<div style='margin-left: 4mm;'>char *a,<br>char *b,<br>int32_t *len<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>len</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.30: match_part</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part(
<div style='margin-left: 4mm;'>String a,<br>char *b,<br>int32_t *len<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>len</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.31: match_part</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part(
<div style='margin-left: 4mm;'>char *a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>len</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.32: match_part</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part(
<div style='margin-left: 4mm;'>String a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.33: match_part</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part(
<div style='margin-left: 4mm;'>char *a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.34: match_part</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part(
<div style='margin-left: 4mm;'>String a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='match_insensitive_str_doc'><h4>&sect;4.3.35: match_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_insensitive(
<div style='margin-left: 4mm;'>char *a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent under case insensitive comparison.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.36: match_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_insensitive(
<div style='margin-left: 4mm;'>String a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent under case insensitive comparison.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.37: match_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_insensitive(
<div style='margin-left: 4mm;'>char *a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent under case insensitive comparison.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.38: match_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_insensitive(
<div style='margin-left: 4mm;'>String a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if a and b are equivalent under case insensitive comparison.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='match_part_insensitive_str_doc'><h4>&sect;4.3.39: match_part_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part_insensitive(
<div style='margin-left: 4mm;'>char *a,<br>char *b,<br>int32_t *len<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>len</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs the same partial matching rule as match_part under case insensitive comparison.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#match_part_doc'>match_part</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.40: match_part_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part_insensitive(
<div style='margin-left: 4mm;'>String a,<br>char *b,<br>int32_t *len<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>len</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs the same partial matching rule as match_part under case insensitive comparison.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#match_part_doc'>match_part</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.41: match_part_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part_insensitive(
<div style='margin-left: 4mm;'>char *a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs the same partial matching rule as match_part under case insensitive comparison.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#match_part_doc'>match_part</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.42: match_part_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part_insensitive(
<div style='margin-left: 4mm;'>String a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs the same partial matching rule as match_part under case insensitive comparison.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#match_part_doc'>match_part</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.43: match_part_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part_insensitive(
<div style='margin-left: 4mm;'>char *a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs the same partial matching rule as match_part under case insensitive comparison.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#match_part_doc'>match_part</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.44: match_part_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool match_part_insensitive(
<div style='margin-left: 4mm;'>String a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs the same partial matching rule as match_part under case insensitive comparison.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#match_part_doc'>match_part</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='compare_str_doc'><h4>&sect;4.3.45: compare</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t compare(
<div style='margin-left: 4mm;'>char *a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns zero if a and b are equivalent,
it returns negative if a sorts before b alphabetically,
and positive if a sorts after b alphabetically.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.46: compare</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t compare(
<div style='margin-left: 4mm;'>String a,<br>char *b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns zero if a and b are equivalent,
it returns negative if a sorts before b alphabetically,
and positive if a sorts after b alphabetically.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.47: compare</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t compare(
<div style='margin-left: 4mm;'>char *a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns zero if a and b are equivalent,
it returns negative if a sorts before b alphabetically,
and positive if a sorts after b alphabetically.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.48: compare</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t compare(
<div style='margin-left: 4mm;'>String a,<br>String b<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns zero if a and b are equivalent,
it returns negative if a sorts before b alphabetically,
and positive if a sorts after b alphabetically.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='find_str_doc'><h4>&sect;4.3.49: find</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t find(
<div style='margin-left: 4mm;'>char *str,<br>int32_t start,<br>char character<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a null terminated string to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>start</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>character</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The character parameter provides the character for which to search.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.50: find</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t find(
<div style='margin-left: 4mm;'>String str,<br>int32_t start,<br>char character<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>start</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>character</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The character parameter provides the character for which to search.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.51: find</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t find(
<div style='margin-left: 4mm;'>char *str,<br>int32_t start,<br>char *characters<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a null terminated string to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>start</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>character</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The characters parameter provides a null terminated array of characters for which to search.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.52: find</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t find(
<div style='margin-left: 4mm;'>String str,<br>int32_t start,<br>char *characters<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>start</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>character</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The characters parameter provides a null terminated array of characters for which to search.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='find_substr_str_doc'><h4>&sect;4.3.53: find_substr</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t find_substr(
<div style='margin-left: 4mm;'>char *str,<br>int32_t start,<br>String seek<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a null terminated string to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>start</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>seek</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.54: find_substr</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t find_substr(
<div style='margin-left: 4mm;'>String str,<br>int32_t start,<br>String seek<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>start</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>seek</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='rfind_substr_str_doc'><h4>&sect;4.3.55: rfind_substr</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t rfind_substr(
<div style='margin-left: 4mm;'>String str,<br>int32_t start,<br>String seek<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>start</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>seek</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='find_substr_insensitive_str_doc'><h4>&sect;4.3.56: find_substr_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t find_substr_insensitive(
<div style='margin-left: 4mm;'>char *str,<br>int32_t start,<br>String seek<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a null terminated string to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>start</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>seek</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call acts as find_substr under case insensitive comparison.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#find_substr_doc'>find_substr</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.57: find_substr_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t find_substr_insensitive(
<div style='margin-left: 4mm;'>String str,<br>int32_t start,<br>String seek<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides a string to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>start</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start parameter provides the index of the first character in str to search.</div></div>
</div>
<div>
<div style='font-weight: 600;'>seek</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The seek parameter provides a string to find in str.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call acts as find_substr under case insensitive comparison.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#find_substr_doc'>find_substr</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='has_substr_str_doc'><h4>&sect;4.3.58: has_substr</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool has_substr(
<div style='margin-left: 4mm;'>char *s,<br>String seek<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the string s contains a substring equivalent to seek.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.59: has_substr</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool has_substr(
<div style='margin-left: 4mm;'>String s,<br>String seek<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the string s contains a substring equivalent to seek.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='has_substr_insensitive_str_doc'><h4>&sect;4.3.60: has_substr_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool has_substr_insensitive(
<div style='margin-left: 4mm;'>char *s,<br>String seek<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.61: has_substr_insensitive</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool has_substr_insensitive(
<div style='margin-left: 4mm;'>String s,<br>String seek<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='copy_fast_unsafe_str_doc'><h4>&sect;4.3.62: copy_fast_unsafe</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t copy_fast_unsafe(
<div style='margin-left: 4mm;'>char *dest,<br>char *src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from the src buffer to the dest buffer.
The copy does not stop until a null terminator is found in src. There
is no safety against overrun so dest must be large enough to contain src.
The null terminator is not written to dest. This call returns the number
of bytes coppied to dest.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.63: copy_fast_unsafe</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
int32_t copy_fast_unsafe(
upgraded string library
2016-07-06 19:18:10 +00:00
<div style='margin-left: 4mm;'>char *dest,<br>String src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from the src string to the dest buffer.
The copy does not stop until src.size characters are coppied. There
is no safety against overrun so dest must be large enough to contain src.
The null terminator is not written to dest. This call returns the number
of bytes coppied to dest.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='copy_checked_str_doc'><h4>&sect;4.3.64: copy_checked</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool copy_checked(
<div style='margin-left: 4mm;'>String *dest,<br>String src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from the src string to the dest string.
The memory_size of dest is checked before any coppying is done.
This call returns non-zero on a successful copy.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='copy_partial_str_doc'><h4>&sect;4.3.65: copy_partial</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool copy_partial(
<div style='margin-left: 4mm;'>String *dest,<br>char *src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from the src buffer to the dest string.
The memory_size of dest is checked if the entire copy cannot be performed,
as many bytes as possible are coppied to dest. This call returns non-zero
if the entire string is coppied to dest.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.66: copy_partial</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool copy_partial(
<div style='margin-left: 4mm;'>String *dest,<br>String src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from the src string to the dest string.
The memory_size of dest is checked if the entire copy cannot be performed,
as many bytes as possible are coppied to dest. This call returns non-zero
if the entire string is coppied to dest.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='copy_str_doc'><h4>&sect;4.3.67: copy</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t copy(
<div style='margin-left: 4mm;'>char *dest,<br>char *src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from src to dest equivalent to copy_fast_unsafe.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#copy_fast_unsafe_doc'>copy_fast_unsafe</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.68: copy</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
void copy(
<div style='margin-left: 4mm;'>String *dest,<br>String src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from src to dest equivalent to copy_checked.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#copy_checked_doc'>copy_checked</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.69: copy</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
void copy(
<div style='margin-left: 4mm;'>String *dest,<br>char *src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call performs a copy from src to dest equivalent to copy_partial.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#copy_partial_doc'>copy_partial</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='append_checked_str_doc'><h4>&sect;4.3.70: append_checked</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append_checked(
<div style='margin-left: 4mm;'>String *dest,<br>String src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='append_partial_str_doc'><h4>&sect;4.3.71: append_partial</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append_partial(
<div style='margin-left: 4mm;'>String *dest,<br>char *src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.72: append_partial</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append_partial(
<div style='margin-left: 4mm;'>String *dest,<br>String src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='append_str_doc'><h4>&sect;4.3.73: append</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append(
<div style='margin-left: 4mm;'>String *dest,<br>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call attemps to append c onto dest. If there is space left in dest's underlying
memory the character is appended and the call returns non-zero.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.74: append</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append(
<div style='margin-left: 4mm;'>String *dest,<br>String src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call is equivalent to append_partial.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#append_partial_doc'>append_partial</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.75: append</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append(
<div style='margin-left: 4mm;'>String *dest,<br>char *src<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call is equivalent to append_partial.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#append_partial_doc'>append_partial</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='terminate_with_null_str_doc'><h4>&sect;4.3.76: terminate_with_null</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool terminate_with_null(
<div style='margin-left: 4mm;'>String *str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call attemps to append a null terminator onto str without effecting the
size of str. This is usually called when the time comes to pass the the string to an
API that requires a null terminator. This call returns non-zero if there was a spare
byte in the strings underlying memory.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='append_padding_str_doc'><h4>&sect;4.3.77: append_padding</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append_padding(
<div style='margin-left: 4mm;'>String *dest,<br>char c,<br>int32_t target_size<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call pads out dest so that it has a size of target_size by appending
the padding character c until the target size is achieved. This call returns
non-zero if dest does not run out of space in the underlying memory.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='replace_char_str_doc'><h4>&sect;4.3.78: replace_char</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
void replace_char(
<div style='margin-left: 4mm;'>String *str,<br>char replace,<br>char with<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter provides the string in which replacement shall be performed.</div></div>
</div>
<div>
<div style='font-weight: 600;'>replace</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The replace character specifies which character should be replaced.</div></div>
</div>
<div>
<div style='font-weight: 600;'>with</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The with character specifies what to write into the positions where replacement occurs.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call replaces all occurances of character in str with another character.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='int_to_str_size_str_doc'><h4>&sect;4.3.79: int_to_str_size</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t int_to_str_size(
<div style='margin-left: 4mm;'>int32_t x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of bytes required to represent x as a string.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='int_to_str_str_doc'><h4>&sect;4.3.80: int_to_str</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool int_to_str(
<div style='margin-left: 4mm;'>String *dest,<br>int32_t x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='append_int_to_str_str_doc'><h4>&sect;4.3.81: append_int_to_str</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append_int_to_str(
<div style='margin-left: 4mm;'>String *dest,<br>int32_t x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='u64_to_str_size_str_doc'><h4>&sect;4.3.82: u64_to_str_size</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t u64_to_str_size(
<div style='margin-left: 4mm;'>uint64_t x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of bytes required to represent x as a string.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='u64_to_str_str_doc'><h4>&sect;4.3.83: u64_to_str</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool u64_to_str(
<div style='margin-left: 4mm;'>String *dest,<br>uint64_t x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='append_u64_to_str_str_doc'><h4>&sect;4.3.84: append_u64_to_str</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append_u64_to_str(
<div style='margin-left: 4mm;'>String *dest,<br>uint64_t x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='float_to_str_size_str_doc'><h4>&sect;4.3.85: float_to_str_size</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t float_to_str_size(
<div style='margin-left: 4mm;'>float x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the number of bytes required to represent x as a string.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='append_float_to_str_str_doc'><h4>&sect;4.3.86: append_float_to_str</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool append_float_to_str(
<div style='margin-left: 4mm;'>String *dest,<br>float x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='float_to_str_str_doc'><h4>&sect;4.3.87: float_to_str</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool float_to_str(
<div style='margin-left: 4mm;'>String *dest,<br>float x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='str_to_int_str_doc'><h4>&sect;4.3.88: str_to_int</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t str_to_int(
<div style='margin-left: 4mm;'>char *str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.89: str_to_int</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t str_to_int(
<div style='margin-left: 4mm;'>String str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='hexchar_to_int_str_doc'><h4>&sect;4.3.90: hexchar_to_int</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t hexchar_to_int(
<div style='margin-left: 4mm;'>char c<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='int_to_hexchar_str_doc'><h4>&sect;4.3.91: int_to_hexchar</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
char int_to_hexchar(
<div style='margin-left: 4mm;'>int32_t x<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='hexstr_to_int_str_doc'><h4>&sect;4.3.92: hexstr_to_int</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
uint32_t hexstr_to_int(
<div style='margin-left: 4mm;'>String str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call interprets str has a hexadecimal representation of an integer and returns
the represented integer value.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='color_to_hexstr_str_doc'><h4>&sect;4.3.93: color_to_hexstr</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool color_to_hexstr(
<div style='margin-left: 4mm;'>String *s,<br>uint32_t color<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='hexstr_to_color_str_doc'><h4>&sect;4.3.94: hexstr_to_color</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool hexstr_to_color(
<div style='margin-left: 4mm;'>String s,<br>uint32_t *out<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call interprets s as a color and writes the 32-bit integer representation into out.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='reverse_seek_slash_str_doc'><h4>&sect;4.3.95: reverse_seek_slash</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t reverse_seek_slash(
<div style='margin-left: 4mm;'>String str,<br>int32_t pos<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call searches for a slash in str by starting pos bytes from the end and going backwards.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.96: reverse_seek_slash</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
int32_t reverse_seek_slash(
<div style='margin-left: 4mm;'>String str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call searches for a slash in str by starting at the end and going backwards.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='front_of_directory_str_doc'><h4>&sect;4.3.97: front_of_directory</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String front_of_directory(
<div style='margin-left: 4mm;'>String dir<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#substr_doc'>substr</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='path_of_directory_str_doc'><h4>&sect;4.3.98: path_of_directory</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String path_of_directory(
<div style='margin-left: 4mm;'>String dir<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#substr_doc'>substr</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='set_last_folder_str_doc'><h4>&sect;4.3.99: set_last_folder</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool set_last_folder(
<div style='margin-left: 4mm;'>String *dir,<br>char *folder_name,<br>char slash<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>dir</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='font-weight: 600;'>folder_name</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='font-weight: 600;'>slash</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The slash parameter specifies what slash to use between names in the directory.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div><h4>&sect;4.3.100: set_last_folder</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool set_last_folder(
<div style='margin-left: 4mm;'>String *dir,<br>String folder_name,<br>char slash<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>dir</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='font-weight: 600;'>folder_name</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='font-weight: 600;'>slash</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The slash parameter specifies what slash to use between names in the directory.</div></div>
</div>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='file_extension_str_doc'><h4>&sect;4.3.101: file_extension</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
String file_extension(
<div style='margin-left: 4mm;'>String str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a substring containing only the file extension of the provided filename.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#substr_doc'>substr</a></div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='remove_last_folder_str_doc'><h4>&sect;4.3.102: remove_last_folder</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool remove_last_folder(
<div style='margin-left: 4mm;'>String *str<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div></div><hr>
fix to make rendering change work on windows compile
2016-07-13 04:43:43 +00:00
<div id='string_set_match_str_doc'><h4>&sect;4.3.103: string_set_match</h4>
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>
upgraded string library
2016-07-06 19:18:10 +00:00
fstr_bool string_set_match(
<div style='margin-left: 4mm;'>String *str_set,<br>int32_t count,<br>String str,<br>int32_t *match_index<br></div>)
</div>
finished up string docs, enhanced the match check rule
2016-07-12 22:17:45 +00:00
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
<div style='font-weight: 600;'>str_set</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str_set parameter is an array of String structs specifying matchable strings.</div></div>
</div>
<div>
<div style='font-weight: 600;'>count</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The count parameter specifies the number of String structs in the str_set array.</div></div>
</div>
<div>
<div style='font-weight: 600;'>str</div>
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str parameter specifies the string to match against the str_set.</div></div>
</div>
<div>
<div style='font-weight: 600;'>match_index</div>
<div style='margin-bottom: 6mm;'><div style='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>
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='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.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#match_doc'>match</a></div></div><hr>
pre-change to single location API names.
2016-06-27 14:25:17 +00:00
</div>
</body>
</html>