|
|
|
@ -22,7 +22,7 @@ ul { list-style: none; padding: 0; margin: 0; }
|
|
|
|
|
<h2 id='section_introduction'>§1 Introduction</h2>
|
|
|
|
|
<div>
|
|
|
|
|
<p>
|
|
|
|
|
This is the documentation for alpha 4.0.10 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>
|
|
|
|
|
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>
|
|
|
|
|
<p>
|
|
|
|
|
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>
|
|
|
|
|
</div>
|
|
|
|
@ -34,9 +34,6 @@ Coming Soon</i><div>
|
|
|
|
|
<ul>
|
|
|
|
|
<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='#memory_alloc_doc'>memory_alloc</a></li>
|
|
|
|
|
<li><a href='#memory_set_protection_doc'>memory_set_protection</a></li>
|
|
|
|
|
<li><a href='#memory_free_doc'>memory_free</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>
|
|
|
|
@ -82,6 +79,9 @@ Coming Soon</i><div>
|
|
|
|
|
<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>
|
|
|
|
|
<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>
|
|
|
|
|
<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>
|
|
|
|
@ -186,26 +186,8 @@ 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.
|
|
|
|
|
|
|
|
|
|
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>
|
|
|
|
|
<div id='memory_alloc_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.3: memory_alloc</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_alloc(
|
|
|
|
|
<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;'>
|
|
|
|
|
<h4>§3.3.4: 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;'>int32_t app->memory_set_protection(
|
|
|
|
|
<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;'>
|
|
|
|
|
<h4>§3.3.5: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>void *mem<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='clipboard_post_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.6: clipboard_post</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>int32_t clipboard_id,<br>char *str,<br>int32_t len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -225,7 +207,7 @@ If the view parameter is NULL, no view will switch to the output.</div><div styl
|
|
|
|
|
Also reports the copy to the operating system, so that it may
|
|
|
|
|
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>
|
|
|
|
|
<div id='clipboard_count_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.7: clipboard_count</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>int32_t clipboard_id<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -235,7 +217,7 @@ be pasted into other applications.</div><div style='margin-top: 3mm; margin-bott
|
|
|
|
|
</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>
|
|
|
|
|
<div id='clipboard_index_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.8: clipboard_index</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<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>)
|
|
|
|
|
</div>
|
|
|
|
@ -259,13 +241,13 @@ be pasted into other applications.</div><div style='margin-top: 3mm; margin-bott
|
|
|
|
|
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>
|
|
|
|
|
<div id='get_buffer_count_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.9: get_buffer_count</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<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>
|
|
|
|
|
<div id='get_buffer_first_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.10: get_buffer_first</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -278,7 +260,7 @@ first len character of the clipboard contents. The output string is not null te
|
|
|
|
|
If the buffer returned does not exist, the loop is finished.
|
|
|
|
|
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='#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>
|
|
|
|
|
<div id='get_buffer_next_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.11: get_buffer_next</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -296,7 +278,7 @@ The global buffer order is kept roughly in the order of most recently used to le
|
|
|
|
|
If the buffer outputted does not exist, the loop is finished.
|
|
|
|
|
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='#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>
|
|
|
|
|
<div id='get_buffer_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.12: get_buffer</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_ID buffer_id,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -310,7 +292,7 @@ Buffers should not be killed or created durring a buffer loop.</div><div style='
|
|
|
|
|
</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 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='#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>
|
|
|
|
|
<div id='get_buffer_by_name_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.13: get_buffer_by_name</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -328,7 +310,7 @@ Buffers should not be killed or created durring a buffer loop.</div><div style='
|
|
|
|
|
</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 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='#Access_Flag_doc'>Access_Flag</a></div></div><hr>
|
|
|
|
|
<div id='buffer_boundary_seek_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.14: buffer_boundary_seek</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<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>)
|
|
|
|
|
</div>
|
|
|
|
@ -352,7 +334,7 @@ Buffers should not be killed or created durring a buffer loop.</div><div style='
|
|
|
|
|
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>
|
|
|
|
|
<div id='buffer_read_range_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.15: buffer_read_range</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<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>)
|
|
|
|
|
</div>
|
|
|
|
@ -378,7 +360,7 @@ The output is not null terminated.
|
|
|
|
|
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>
|
|
|
|
|
<div id='buffer_replace_range_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.16: buffer_replace_range</h4>
|
|
|
|
|
<h4>§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(
|
|
|
|
|
<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>)
|
|
|
|
|
</div>
|
|
|
|
@ -411,7 +393,7 @@ from start to end.
|
|
|
|
|
This call fails if the buffer does not exist, or if the replace
|
|
|
|
|
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>
|
|
|
|
|
<div id='buffer_batch_edit_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.17: buffer_batch_edit</h4>
|
|
|
|
|
<h4>§3.3.14: 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(
|
|
|
|
|
<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>
|
|
|
|
@ -437,7 +419,7 @@ range is not within the bounds of the buffer.</div><div style='margin-top: 3mm;
|
|
|
|
|
</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 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>
|
|
|
|
|
<div id='buffer_set_setting_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.18: buffer_set_setting</h4>
|
|
|
|
|
<h4>§3.3.15: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>Buffer_Setting_ID setting,<br>int32_t value<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -455,7 +437,7 @@ range is not within the bounds of the buffer.</div><div style='margin-top: 3mm;
|
|
|
|
|
</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_Setting_ID_doc'>Buffer_Setting_ID</a></div></div><hr>
|
|
|
|
|
<div id='buffer_auto_indent_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.19: buffer_auto_indent</h4>
|
|
|
|
|
<h4>§3.3.16: 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(
|
|
|
|
|
<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>)
|
|
|
|
|
</div>
|
|
|
|
@ -484,7 +466,7 @@ 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
|
|
|
|
|
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>
|
|
|
|
|
<div id='create_buffer_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.20: create_buffer</h4>
|
|
|
|
|
<h4>§3.3.17: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *filename,<br>int32_t filename_len,<br>Buffer_Create_Flag flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -506,7 +488,7 @@ If the buffer does not exist a new buffer is created and named after the given f
|
|
|
|
|
the filename corresponds to a file on the disk that file is loaded and put into buffer, if
|
|
|
|
|
the filename does not correspond to a file on disk the buffer is created empty.</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_Create_Flag_doc'>Buffer_Create_Flag</a></div></div><hr>
|
|
|
|
|
<div id='save_buffer_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.21: save_buffer</h4>
|
|
|
|
|
<h4>§3.3.18: 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(
|
|
|
|
|
<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>)
|
|
|
|
|
</div>
|
|
|
|
@ -528,7 +510,7 @@ 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>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div></div><hr>
|
|
|
|
|
<div id='kill_buffer_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.22: kill_buffer</h4>
|
|
|
|
|
<h4>§3.3.19: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Identifier buffer,<br>View_ID view_id,<br>Buffer_Kill_Flag flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -548,7 +530,7 @@ the filename does not correspond to a file on disk the buffer is created empty.<
|
|
|
|
|
dialogue needs to be displayed the provided view is used to show the dialogue.
|
|
|
|
|
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>
|
|
|
|
|
<div id='get_view_first_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.23: get_view_first</h4>
|
|
|
|
|
<h4>§3.3.20: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -561,7 +543,7 @@ If the view is not open the kill fails.</div><div style='margin-top: 3mm; margin
|
|
|
|
|
If the View_Summary returned is a null summary, the loop is finished.
|
|
|
|
|
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;'>
|
|
|
|
|
<h4>§3.3.24: get_view_next</h4>
|
|
|
|
|
<h4>§3.3.21: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -578,7 +560,7 @@ Views should not be closed or opened durring a view loop.</div><div style='margi
|
|
|
|
|
If the view outputted does not exist, the loop is finished.
|
|
|
|
|
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;'>
|
|
|
|
|
<h4>§3.3.25: get_view</h4>
|
|
|
|
|
<h4>§3.3.22: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_ID view_id,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -592,7 +574,7 @@ Views should not be closed or opened durring a view loop.</div><div style='margi
|
|
|
|
|
</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 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>
|
|
|
|
|
<div id='get_active_view_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.26: get_active_view</h4>
|
|
|
|
|
<h4>§3.3.23: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -602,7 +584,7 @@ Views should not be closed or opened durring a view loop.</div><div style='margi
|
|
|
|
|
</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 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>
|
|
|
|
|
<div id='open_view_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.27: open_view</h4>
|
|
|
|
|
<h4>§3.3.24: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view_location,<br>View_Split_Position position<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -618,7 +600,7 @@ Views should not be closed or opened durring a view loop.</div><div style='margi
|
|
|
|
|
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;'>
|
|
|
|
|
<h4>§3.3.28: close_view</h4>
|
|
|
|
|
<h4>§3.3.25: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -631,7 +613,7 @@ 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>
|
|
|
|
|
<div id='set_active_view_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.29: set_active_view</h4>
|
|
|
|
|
<h4>§3.3.26: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -643,7 +625,7 @@ If the given view is the last open view in the system, the call will fail.</div>
|
|
|
|
|
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>
|
|
|
|
|
<div id='view_set_setting_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.30: view_set_setting</h4>
|
|
|
|
|
<h4>§3.3.27: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>View_Setting_ID setting,<br>int32_t value<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -661,7 +643,7 @@ from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; colo
|
|
|
|
|
</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>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>
|
|
|
|
|
<div id='view_set_split_proportion_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.31: view_set_split_proportion</h4>
|
|
|
|
|
<h4>§3.3.28: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>float t<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -675,7 +657,7 @@ from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; colo
|
|
|
|
|
</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><hr>
|
|
|
|
|
<div id='view_compute_cursor_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.32: view_compute_cursor</h4>
|
|
|
|
|
<h4>§3.3.29: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Seek seek,<br>Full_Cursor *cursor_out<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -693,7 +675,7 @@ from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; colo
|
|
|
|
|
</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 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>
|
|
|
|
|
<div id='view_set_cursor_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.33: view_set_cursor</h4>
|
|
|
|
|
<h4>§3.3.30: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Seek seek,<br>bool32 set_preferred_x<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -713,7 +695,7 @@ from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; colo
|
|
|
|
|
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>
|
|
|
|
|
<div id='view_set_mark_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.34: view_set_mark</h4>
|
|
|
|
|
<h4>§3.3.31: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Seek seek<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -727,7 +709,7 @@ cursor in the same column or x position.</div><div style='margin-top: 3mm; margi
|
|
|
|
|
</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;'>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>
|
|
|
|
|
<div id='view_set_highlight_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.35: view_set_highlight</h4>
|
|
|
|
|
<h4>§3.3.32: 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(
|
|
|
|
|
<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>)
|
|
|
|
|
</div>
|
|
|
|
@ -752,7 +734,7 @@ 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
|
|
|
|
|
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;'>
|
|
|
|
|
<h4>§3.3.36: view_set_buffer</h4>
|
|
|
|
|
<h4>§3.3.33: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_ID buffer_id,<br>Set_Buffer_Flag flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -771,7 +753,7 @@ the turn_on set to false, will switch back to showing the cursor.</div></div><hr
|
|
|
|
|
<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
|
|
|
|
|
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;'>
|
|
|
|
|
<h4>§3.3.37: view_post_fade</h4>
|
|
|
|
|
<h4>§3.3.34: 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(
|
|
|
|
|
<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>)
|
|
|
|
|
</div>
|
|
|
|
@ -797,7 +779,7 @@ cancels and dialogue shown in the view and displays the file.</div><div style='m
|
|
|
|
|
</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>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#int_color_doc'>int_color</a></div></div><hr>
|
|
|
|
|
<div id='get_user_input_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.38: get_user_input</h4>
|
|
|
|
|
<h4>§3.3.35: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Input_Type_Flag get_type,<br>Input_Type_Flag abort_type<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -815,19 +797,19 @@ command is executed an abort signal is returned. If an abort signal is ever ret
|
|
|
|
|
command should finish execution without any more calls that preempt the command.
|
|
|
|
|
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>
|
|
|
|
|
<div id='get_command_input_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.39: get_command_input</h4>
|
|
|
|
|
<h4>§3.3.36: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app<br></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 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>
|
|
|
|
|
<div id='get_mouse_state_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.40: get_mouse_state</h4>
|
|
|
|
|
<h4>§3.3.37: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app<br></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 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>
|
|
|
|
|
<div id='start_query_bar_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.41: start_query_bar</h4>
|
|
|
|
|
<h4>§3.3.38: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Query_Bar *bar,<br>uint32_t flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -847,7 +829,7 @@ can be changed after the call to start_query_bar and the query bar shown by 4cod
|
|
|
|
|
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>
|
|
|
|
|
<div id='end_query_bar_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.42: end_query_bar</h4>
|
|
|
|
|
<h4>§3.3.39: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Query_Bar *bar,<br>uint32_t flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -861,7 +843,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
</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;'>Stops showing the particular query bar specified by the bar parameter.</div></div><hr>
|
|
|
|
|
<div id='print_message_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.43: print_message</h4>
|
|
|
|
|
<h4>§3.3.40: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *str,<br>int32_t len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -875,7 +857,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
</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 posts a string to the *messages* buffer.</div></div><hr>
|
|
|
|
|
<div id='change_theme_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.44: change_theme</h4>
|
|
|
|
|
<h4>§3.3.41: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -889,7 +871,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
</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 changes 4coder's theme to one of the built in themes.</div></div><hr>
|
|
|
|
|
<div id='change_font_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.45: change_font</h4>
|
|
|
|
|
<h4>§3.3.42: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -903,7 +885,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
</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 changes 4coder's font to one of the built in fonts.</div></div><hr>
|
|
|
|
|
<div id='set_theme_colors_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.46: set_theme_colors</h4>
|
|
|
|
|
<h4>§3.3.43: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Theme_Color *colors,<br>int32_t count<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -919,7 +901,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
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>
|
|
|
|
|
<div id='get_theme_colors_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.47: get_theme_colors</h4>
|
|
|
|
|
<h4>§3.3.44: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Theme_Color *colors,<br>int32_t count<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -935,7 +917,7 @@ no change is made to the color pallet.</div></div><hr>
|
|
|
|
|
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>
|
|
|
|
|
<div id='directory_get_hot_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.48: directory_get_hot</h4>
|
|
|
|
|
<h4>§3.3.45: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *out,<br>int32_t capacity<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -953,7 +935,7 @@ 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
|
|
|
|
|
directories controlled on the custom side.</div></div><hr>
|
|
|
|
|
<div id='get_file_list_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.49: get_file_list</h4>
|
|
|
|
|
<h4>§3.3.46: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *dir,<br>int32_t len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -969,7 +951,7 @@ directories controlled on the custom side.</div></div><hr>
|
|
|
|
|
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;'>
|
|
|
|
|
<h4>§3.3.50: free_file_list</h4>
|
|
|
|
|
<h4>§3.3.47: 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(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>File_List list<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -978,6 +960,24 @@ when it is no longer in use.</div></div><hr>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides the file list to be freed.</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;'>After this call the file list passed in should not be read or written to.</div></div><hr>
|
|
|
|
|
<div id='memory_allocate_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.48: 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(
|
|
|
|
|
<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;'>
|
|
|
|
|
<h4>§3.3.49: 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(
|
|
|
|
|
<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;'>
|
|
|
|
|
<h4>§3.3.50: 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(
|
|
|
|
|
<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>
|
|
|
|
|
<div id='file_exists_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.51: 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(
|
|
|
|
@ -1373,15 +1373,15 @@ Flags can be combined with bit or to specify a state with multiple modifiers.</d
|
|
|
|
|
<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>
|
|
|
|
|
<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>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></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;'>MemProtect_Write</span> = 0x2</span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></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;'>MemProtect_Execute</span> = 0x4</span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Buffer_Create_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|