4coder API

Table of Contents

§1 Introduction

This is the documentation for alpha 4.0.11 The documentation is still under construction so some of the links are linking to sections that have not been written yet. What is here should be correct and I suspect useful even without some of the other sections.

If you have questions or discover errors please contact editor@4coder.net or to get help from community members you can post on the 4coder forums hosted on handmade.network at 4coder.handmade.network

§2 4coder Systems

Coming Soon

§3 Types and Functions

§3.1 Function List

§3.2 Type List

§3.3 Function Descriptions

§3.3.1: exec_command

bool32 app->exec_command(
Application_Links *app,
Command_ID command_id
)
Parameters
command_id
The command_id parameter specifies which internal command to execute.
Return
This call returns non-zero if command_id named a valid internal command.
Description
A call to exec_command executes an internal command. If command_id is invalid a warning is posted to *messages*.
See Also
Command_ID

§3.3.2: exec_system_command

bool32 app->exec_system_command(
Application_Links *app,
View_Summary *view,
Buffer_Identifier buffer,
char *path,
int32_t path_len,
char *command,
int32_t command_len,
Command_Line_Input_Flag flags
)
Parameters
view
If the view parameter is non-null it specifies a view to display the command's output buffer.
buffer
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.
path
The path parameter specifies the path in which the command shall be executed. The string need not be null terminated.
path_len
The parameter path_len specifies the length of the path string.
command
The command parameter specifies the command that shall be executed. The string need not be null terminated.
command_len
The parameter command_len specifies the length of the command string.
flags
Flags for the behavior of the call are specified in the flags parameter.
Return
This call returns non-zero on success.
Description
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. 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.
See Also
Buffer_Identifier
Command_Line_Input_Flag

§3.3.3: clipboard_post

void app->clipboard_post(
Application_Links *app,
int32_t clipboard_id,
char *str,
int32_t len
)
Parameters
clipboard_id
This parameter is set up to prepare for future features, it should always be 0 for now.
str
The str parameter specifies the string to be posted to the clipboard, it need not be null terminated.
len
The len parameter specifies the length of the str string.
Description
Stores the string str in the clipboard initially with index 0. Also reports the copy to the operating system, so that it may be pasted into other applications.
See Also
The_4coder_Clipboard

§3.3.4: clipboard_count

int32_t app->clipboard_count(
Application_Links *app,
int32_t clipboard_id
)
Parameters
clipboard_id
This parameter is set up to prepare for future features, it should always be 0 for now.
Description
This call returns the number of items in the clipboard.
See Also
The_4coder_Clipboard

§3.3.5: clipboard_index

int32_t app->clipboard_index(
Application_Links *app,
int32_t clipboard_id,
int32_t item_index,
char *out,
int32_t len
)
Parameters
clipboard_id
This parameter is set up to prepare for future features, it should always be 0 for now.
item_index
This parameter specifies which item to read, 0 is the most recent copy, 1 is the second most recent copy, etc.
out
This parameter provides a buffer where the clipboard contents are written. This parameter may be NULL.
len
This parameter specifies the length of the out buffer.
Return
This call returns the size of the item associated with item_index.
Description
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.
See Also
The_4coder_Clipboard

§3.3.6: get_buffer_count

int32_t app->get_buffer_count(
Application_Links *app
)
Description
TODO

§3.3.7: get_buffer_first

Buffer_Summary app->get_buffer_first(
Application_Links *app,
Access_Flag access
)
Parameters
access
The access parameter determines what levels of protection this call can access.
Return
This call returns the summary of the first buffer in a buffer loop.
Description
This call begins a loop across all the buffers. If the buffer returned does not exist, the loop is finished. Buffers should not be killed durring a buffer loop.
See Also
Buffer_Summary
Access_Flag
get_buffer_next

§3.3.8: get_buffer_next

void app->get_buffer_next(
Application_Links *app,
Buffer_Summary *buffer,
Access_Flag access
)
Parameters
buffer
The Buffer_Summary pointed to by buffer is iterated to the next buffer or to a null summary if this is the last buffer.
access
The access parameter determines what levels of protection this call can access. The buffer outputted will be the next buffer that is accessible.
Description
This call steps a Buffer_Summary to the next buffer in the global buffer order. The global buffer order is kept roughly in the order of most recently used to least recently used. If the buffer outputted does not exist, the loop is finished. Buffers should not be killed or created durring a buffer loop.
See Also
Buffer_Summary
Access_Flag
get_buffer_first

§3.3.9: get_buffer

Buffer_Summary app->get_buffer(
Application_Links *app,
Buffer_ID buffer_id,
Access_Flag access
)
Parameters
buffer_id
The parameter buffer_id specifies which buffer to try to get.
access
The access parameter determines what levels of protection this call can access.
Return
This call returns a summary that describes the indicated buffer if it exists and is accessible.
See Also
Buffer_Summary
Access_Flag
Buffer_ID

§3.3.10: get_buffer_by_name

Buffer_Summary app->get_buffer_by_name(
Application_Links *app,
char *name,
int32_t len,
Access_Flag access
)
Parameters
name
The name parameter specifies the buffer name to try to get. The string need not be null terminated.
len
The len parameter specifies the length of the name string.
access
The access parameter determines what levels of protection this call can access.
Return
This call returns a summary that describes the indicated buffer if it exists and is accessible.
See Also
Buffer_Summary
Access_Flag

§3.3.11: buffer_boundary_seek

int32_t app->buffer_boundary_seek(
Application_Links *app,
Buffer_Summary *buffer,
int32_t start_pos,
bool32 seek_forward,
Seek_Boundary_Flag flags
)
Parameters
buffer
The buffer parameter specifies the buffer through which to seek.
start_pos
The beginning position of the seek is specified by start_pos measured in absolute position.
seek_forward
If this parameter is non-zero it indicates that the seek should move foward through the buffer.
flags
This field specifies the types of boundaries at which the seek should stop.
Return
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.
See Also
Seek_Boundary_Flag
4coder_Buffer_Positioning_System

§3.3.12: buffer_read_range

bool32 app->buffer_read_range(
Application_Links *app,
Buffer_Summary *buffer,
int32_t start,
int32_t end,
char *out
)
Parameters
buffer
This parameter specifies the buffer to read.
start
This parameter specifies absolute position of the first character in the read range.
end
This parameter specifies the absolute position of the the character one past the end of the read range.
out
This paramter provides the output character buffer to fill with the result of the read.
Return
This call returns non-zero if the read succeeds.
Description
The output buffer must have a capacity of at least (end - start). 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.
See Also
4coder_Buffer_Positioning_System

§3.3.13: buffer_replace_range

bool32 app->buffer_replace_range(
Application_Links *app,
Buffer_Summary *buffer,
int32_t start,
int32_t end,
char *str,
int32_t len
)
Parameters
buffer
This parameter specifies the buffer to edit.
start
This parameter specifies absolute position of the first character in the replace range.
end
This parameter specifies the absolute position of the the character one past the end of the replace range.
str
This parameter specifies the the string to write into the range; it need not be null terminated.
len
This parameter specifies the length of the str string.
Return
This call returns non-zero if the replacement succeeds.
Description
If this call succeeds it deletes the range from start to end 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 range is not within the bounds of the buffer.
See Also
4coder_Buffer_Positioning_System

§3.3.14: buffer_compute_cursor

bool32 app->buffer_compute_cursor(
Application_Links *app,
Buffer_Summary *buffer,
Buffer_Seek seek,
Partial_Cursor *cursor_out
)
Parameters
buffer
The buffer parameter specifies the buffer on which to run the cursor computation.
seek
The seek parameter specifies the target position for the seek.
cursor_out
On success this struct is filled with the result of the seek.
Return
This call returns non-zero on success.
Description
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.
See Also
Buffer_Seek
Partial_Cursor

§3.3.15: buffer_batch_edit

bool32 app->buffer_batch_edit(
Application_Links *app,
Buffer_Summary *buffer,
char *str,
int32_t str_len,
Buffer_Edit *edits,
int32_t edit_count,
Buffer_Batch_Edit_Type type
)
Parameters
str
This parameter provides all of the source string for the edits in the batch.
str_len
This parameter specifies the length of the str string.
edits
This parameter provides about the source string and destination range of each edit as an array.
edit_count
This parameter specifies the number of Buffer_Edit structs in edits.
type
This prameter specifies what type of batch edit to execute.
Return
This call returns non-zero if the batch edit succeeds.
Description
TODO
See Also
Buffer_Edit
Buffer_Batch_Edit_Type

§3.3.16: buffer_set_setting

bool32 app->buffer_set_setting(
Application_Links *app,
Buffer_Summary *buffer,
Buffer_Setting_ID setting,
int32_t value
)
Parameters
buffer
The buffer parameter specifies the buffer on which to set a setting.
setting
The setting parameter identifies the setting that shall be changed.
value
The value parameter specifies the value to which the setting shall be changed.
See Also
Buffer_Setting_ID

§3.3.17: buffer_auto_indent

bool32 app->buffer_auto_indent(
Application_Links *app,
Buffer_Summary *buffer,
int32_t start,
int32_t end,
int32_t tab_width,
Auto_Indent_Flag flags
)
Parameters
buffer
The buffer specifies the buffer in which to apply auto indentation.
start
This parameter specifies the absolute position of the start of the indentation range.
end
This parameter specifies the absolute position of the end of the indentation range.
tab_width
The tab_width parameter specifies how many spaces should be used for one indentation in space mode.
flags
This parameter specifies behaviors for the indentation.
Return
This call returns non-zero when the call succeeds.
Description
Applies the built in auto-indentation rule to the code in the range from 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.
See Also
Auto_Indent_Flag
4coder_Buffer_Positioning_System

§3.3.18: create_buffer

Buffer_Summary app->create_buffer(
Application_Links *app,
char *filename,
int32_t filename_len,
Buffer_Create_Flag flags
)
Parameters
filename
The filename parameter specifies the name of the file to be opened or created; it need not be null terminated.
filename_len
The filename_len parameter spcifies the length of the filename string.
flags
The flags parameter specifies behaviors for buffer creation.
Return
This call returns the summary of the created buffer.
Description
Tries to create a new buffer and associate it to the given filename. If such a buffer already exists the existing buffer is returned in the Buffer_Summary and no new buffer is created. If the buffer does not exist a new buffer is created and named after the given filename. If the filename corresponds to a file on the disk that file is loaded and put into buffer, if the filename does not correspond to a file on disk the buffer is created empty.
See Also
Buffer_Summary
Buffer_Create_Flag

§3.3.19: save_buffer

bool32 app->save_buffer(
Application_Links *app,
Buffer_Summary *buffer,
char *filename,
int32_t filename_len,
uint32_t flags
)
Parameters
buffer
The buffer parameter specifies the buffer to save to a file.
filename
The filename parameter specifies the name of the file to associated to the buffer; it need not be null terminated.
filename_len
The filename_len parameter specifies the length of the filename string.
flags
This parameter is not currently used and should be set to 0 for now.
Return
This call returns non-zero on success.

§3.3.20: kill_buffer

bool32 app->kill_buffer(
Application_Links *app,
Buffer_Identifier buffer,
View_ID view_id,
Buffer_Kill_Flag flags
)
Parameters
buffer
The buffer parameter specifies the buffer to try to kill.
view_id
The view_id parameter specifies the view that will contain the "are you sure" dialogue if the buffer is dirty.
flags
The flags parameter specifies behaviors for the buffer kill.
Return
This call returns non-zero if the buffer is killed.
Description
Tries to kill the idenfied buffer. If the buffer is dirty and the "are you sure" dialogue needs to be displayed the provided view is used to show the dialogue. If the view is not open the kill fails.
See Also
Buffer_Kill_Flag
Buffer_Identifier

§3.3.21: get_view_first

View_Summary app->get_view_first(
Application_Links *app,
Access_Flag access
)
Parameters
access
The access parameter determines what levels of protection this call can access.
Return
This call returns the summary of the first view in a view loop.
Description
This call begins a loop across all the open views. If the View_Summary returned is a null summary, the loop is finished. Views should not be closed or opened durring a view loop.
See Also
Access_Flag
get_view_next

§3.3.22: get_view_next

void app->get_view_next(
Application_Links *app,
View_Summary *view,
Access_Flag access
)
Parameters
view
The View_Summary pointed to by view is iterated to the next view or to a null summary if this is the last view.
access
The access parameter determines what levels of protection this call can access. The view outputted will be the next view that is accessible.
Description
This call steps a View_Summary to the next view in the global view order. If the view outputted does not exist, the loop is finished. Views should not be closed or opened durring a view loop.
See Also
Access_Flag
get_view_first

§3.3.23: get_view

View_Summary app->get_view(
Application_Links *app,
View_ID view_id,
Access_Flag access
)
Parameters
view_id
The view_id specifies the view to try to get.
access
The access parameter determines what levels of protection this call can access.
Return
This call returns a summary that describes the indicated view if it is open and accessible.
See Also
Access_Flag

§3.3.24: get_active_view

View_Summary app->get_active_view(
Application_Links *app,
Access_Flag access
)
Parameters
access
The access parameter determines what levels of protection this call can access.
Return
This call returns a summary that describes the active view.
See Also
set_active_view
Access_Flag

§3.3.25: open_view

View_Summary app->open_view(
Application_Links *app,
View_Summary *view_location,
View_Split_Position position
)
Parameters
view_location
The view_location parameter specifies the view to split to open the new view.
position
The position parameter specifies how to split the view and where to place the new view.
Return
If this call succeeds it returns a View_Summary describing the newly created view, if it fails it returns a null summary.
Description
4coder is built with a limit of 16 views. If 16 views are already open when this is called the call will fail.
See Also
View_Split_Position

§3.3.26: close_view

bool32 app->close_view(
Application_Links *app,
View_Summary *view
)
Parameters
view
The view parameter specifies which view to close.
Return
This call returns non-zero on success.
Description
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.

§3.3.27: set_active_view

bool32 app->set_active_view(
Application_Links *app,
View_Summary *view
)
Parameters
view
The view parameter specifies which view to make active.
Return
This call returns non-zero on success.
Description
If the given view is open, it is set as the active view, and takes subsequent commands and is returned from get_active_view.
See Also
get_active_view

§3.3.28: view_set_setting

bool32 app->view_set_setting(
Application_Links *app,
View_Summary *view,
View_Setting_ID setting,
int32_t value
)
Parameters
view
The view parameter specifies the view on which to set a setting.
setting
The setting parameter identifies the setting that shall be changed.
value
The value parameter specifies the value to which the setting shall be changed.
Return
This call returns non-zero on success.
See Also
View_Setting_ID

§3.3.29: view_set_split_proportion

bool32 app->view_set_split_proportion(
Application_Links *app,
View_Summary *view,
float t
)
Parameters
view
The view parameter specifies which view shall have it's size adjusted.
t
The t parameter specifies the proportion of the containing box that the view should occupy. t should be in [0,1].
Return
This call returns non-zero on success.

§3.3.30: view_compute_cursor

bool32 app->view_compute_cursor(
Application_Links *app,
View_Summary *view,
Buffer_Seek seek,
Full_Cursor *cursor_out
)
Parameters
view
The view parameter specifies the view on which to run the cursor computation.
seek
The seek parameter specifies the target position for the seek.
cursor_out
On success this struct is filled with the result of the seek.
Return
This call returns non-zero on success.
Description
Computes a Full_Cursor for the given seek position with no side effects.
See Also
Buffer_Seek
Full_Cursor

§3.3.31: view_set_cursor

bool32 app->view_set_cursor(
Application_Links *app,
View_Summary *view,
Buffer_Seek seek,
bool32 set_preferred_x
)
Parameters
view
The view parameter specifies the view in which to set the cursor.
seek
The seek parameter specifies the target position for the seek.
set_preferred_x
If this parameter is true the preferred x is updated to match the new cursor x.
Return
This call returns non-zero on success.
Description
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.
See Also
Buffer_Seek

§3.3.32: view_set_scroll

bool32 app->view_set_scroll(
Application_Links *app,
View_Summary *view,
GUI_Scroll_Vars scroll
)
Description
TODO
See Also
GUI_Scroll_Vars

§3.3.33: view_set_mark

bool32 app->view_set_mark(
Application_Links *app,
View_Summary *view,
Buffer_Seek seek
)
Parameters
view
The view parameter specifies the view in which to set the mark.
seek
The seek parameter specifies the target position for the seek.
Return
This call returns non-zero on success.
Description
This call sets the the view's mark position.
See Also
Buffer_Seek

§3.3.34: view_set_highlight

bool32 app->view_set_highlight(
Application_Links *app,
View_Summary *view,
int32_t start,
int32_t end,
bool32 turn_on
)
Parameters
view
The view parameter specifies the view in which to set the highlight.
start
This parameter specifies the absolute position of the first character of the highlight range.
end
This parameter specifies the absolute position of the character one past the end of the highlight range.
turn_on
This parameter indicates whether the highlight is being turned on or off.
Return
This call returns non-zero on success.
Description
The highlight is mutually exclusive to the cursor. When the turn_on parameter is set to true the highlight will be shown and the cursor will be hidden. After that either setting the cursor with view_set_cursor or calling view_set_highlight and the turn_on set to false, will switch back to showing the cursor.

§3.3.35: view_set_buffer

bool32 app->view_set_buffer(
Application_Links *app,
View_Summary *view,
Buffer_ID buffer_id,
Set_Buffer_Flag flags
)
Parameters
view
The view parameter specifies the view in which to display the buffer.
buffer_id
The buffer_id parameter specifies which buffer to show in the view.
flags
The flags parameter specifies behaviors for setting the buffer.
Return
This call returns non-zero on success.
Description
On success view_set_buffer sets the specified view's current buffer and cancels and dialogue shown in the view and displays the file.
See Also
Set_Buffer_Flag

§3.3.36: view_post_fade

bool32 app->view_post_fade(
Application_Links *app,
View_Summary *view,
float seconds,
int32_t start,
int32_t end,
int_color color
)
Parameters
view
The view parameter specifies the view onto which the fade effect shall be posted.
seconds
This parameter specifies the number of seconds the fade effect should last.
start
This parameter specifies the absolute position of the first character of the fade range.
end
This parameter specifies the absolute position of the character one past the end of the fdae range.
color
The color parameter specifies the initial color of the text before it fades to it's natural color.
Return
This call returns non-zero on success.
See Also
int_color

§3.3.37: get_user_input

User_Input app->get_user_input(
Application_Links *app,
Input_Type_Flag get_type,
Input_Type_Flag abort_type
)
Parameters
get_type
The get_type parameter specifies the set of input types that should be returned.
abort_type
The get_type parameter specifies the set of input types that should trigger an abort signal.
Return
This call returns a User_Input that describes a user input event.
Description
This call preempts the command. The command is resumed if either a get or abort condition 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. If a get condition is met the user input is returned.
See Also
Input_Type_Flag
User_Input

§3.3.38: get_command_input

User_Input app->get_command_input(
Application_Links *app
)
Return
This call returns the input that triggered the currently executing command.
See Also
User_Input

§3.3.39: get_mouse_state

Mouse_State app->get_mouse_state(
Application_Links *app
)
Return
This call returns the current mouse state as of the beginning of the frame.
See Also
Mouse_State

§3.3.40: start_query_bar

bool32 app->start_query_bar(
Application_Links *app,
Query_Bar *bar,
uint32_t flags
)
Parameters
bar
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.
flags
This parameter is not currently used and should be 0 for now.
Return
This call returns non-zero on success.
Description
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.

§3.3.41: end_query_bar

void app->end_query_bar(
Application_Links *app,
Query_Bar *bar,
uint32_t flags
)
Parameters
bar
This parameter should be a bar pointer of a currently active query bar.
flags
This parameter is not currently used and should be 0 for now.
Description
Stops showing the particular query bar specified by the bar parameter.


§3.3.43: change_theme

void app->change_theme(
Application_Links *app,
char *name,
int32_t len
)
Parameters
name
The name parameter specifies the name of the theme to begin using; it need not be null terminated.
len
The len parameter specifies the length of the name string.
Description
This call changes 4coder's color pallet to one of the built in themes.

§3.3.44: change_font

void app->change_font(
Application_Links *app,
char *name,
int32_t len,
bool32 apply_to_all_files
)
Parameters
name
The name parameter specifies the name of the font to begin using; it need not be null terminated.
len
The len parameter specifies the length of the name string.
apply_to_all_files
If this is set all open files change to this font. Usually this should be true durring the start hook because several files already exist at that time.
Description
This call changes 4coder's default font to one of the built in fonts.

§3.3.45: buffer_set_font

void app->buffer_set_font(
Application_Links *app,
Buffer_Summary *buffer,
char *name,
int32_t len
)
Parameters
buffer
This parameter the buffer that shall have it's font changed
name
The name parameter specifies the name of the font to begin using; it need not be null terminated.
len
The len parameter specifies the length of the name string.
Description
This call sets the display font of a particular buffer.

§3.3.46: set_theme_colors

void app->set_theme_colors(
Application_Links *app,
Theme_Color *colors,
int32_t count
)
Parameters
colors
The colors pointer provides an array of color structs pairing differet style tags to color codes.
count
The count parameter specifies the number of Theme_Color structs in the colors array.
Description
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.

§3.3.47: get_theme_colors

void app->get_theme_colors(
Application_Links *app,
Theme_Color *colors,
int32_t count
)
Parameters
colors
an array of color structs listing style tags to get color values for
count
the number of color structs in the colors array
Description
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.

§3.3.48: directory_get_hot

int32_t app->directory_get_hot(
Application_Links *app,
char *out,
int32_t capacity
)
Parameters
out
This parameter provides a character buffer that receives the 4coder 'hot directory'.
capacity
This parameter specifies the maximum size to be output to the out buffer.
Return
This call returns the size of the string written into the buffer.
Description
4coder has a concept of a 'hot directory' which is the directory most recently 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.

§3.3.49: get_file_list

File_List app->get_file_list(
Application_Links *app,
char *dir,
int32_t len
)
Parameters
dir
This parameter specifies the directory whose files will be enumerated in the returned list; it need not be null terminated.
len
This parameter the length of the dir string.
Return
This call returns a File_List struct containing pointers to the names of the files in the specified directory. The File_List returned should be passed to free_file_list when it is no longer in use.

§3.3.50: free_file_list

void app->free_file_list(
Application_Links *app,
File_List list
)
Parameters
list
This parameter provides the file list to be freed.
Description
After this call the file list passed in should not be read or written to.

§3.3.51: memory_allocate

void* app->memory_allocate(
Application_Links *app,
int32_t size
)
Description
TODO

§3.3.52: memory_set_protection

bool32 app->memory_set_protection(
Application_Links *app,
void *ptr,
int32_t size,
Memory_Protect_Flags flags
)
Description
TODO

§3.3.53: memory_free

void app->memory_free(
Application_Links *app,
void *mem,
int32_t size
)
Description
TODO

§3.3.54: file_exists

bool32 app->file_exists(
Application_Links *app,
char *filename,
int32_t len
)
Parameters
filename
This parameter specifies the full path to a file; it need not be null terminated.
len
This parameter specifies the length of the filename string.
Return
This call returns non-zero if and only if the file exists.

§3.3.55: directory_cd

bool32 app->directory_cd(
Application_Links *app,
char *dir,
int32_t *len,
int32_t capacity,
char *rel_path,
int32_t rel_len
)
Parameters
dir
This parameter provides a character buffer that stores a directory; it need not be null terminated.
len
This parameter specifies the length of the dir string.
capacity
This parameter specifies the maximum size of the dir string.
rel_path
This parameter specifies the path to change to, may include '.' or '..'; it need not be null terminated.
rel_len
This parameter specifies the length of the rel_path string.
Return
This call returns non-zero if the call succeeds.
Description
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. 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.

§3.3.56: get_4ed_path

bool32 app->get_4ed_path(
Application_Links *app,
char *out,
int32_t capacity
)
Parameters
out
This parameter provides a character buffer that receives the path to the 4ed executable file.
capacity
This parameter specifies the maximum capacity of the out buffer.
Return
This call returns non-zero on success.

§3.3.57: show_mouse_cursor

void app->show_mouse_cursor(
Application_Links *app,
Mouse_Cursor_Show_Type show
)
Parameters
show
This parameter specifies the new state of the mouse cursor.
See Also
Mouse_Cursor_Show_Type

§3.3.58: toggle_fullscreen

void app->toggle_fullscreen(
Application_Links *app
)
No documentation generated for this function, assume it is non-public.

§3.3.59: is_fullscreen

bool32 app->is_fullscreen(
Application_Links *app
)
No documentation generated for this function, assume it is non-public.

§3.3.60: send_exit_signal

void app->send_exit_signal(
Application_Links *app
)
No documentation generated for this function, assume it is non-public.

§3.4 Type Descriptions

§4 String Library

§4.1 String Intro

    Coming Soon

    §4.2 String Function List

    §4.3 String Function Descriptions

      §4.3.1: char_is_slash

      fstr_bool char_is_slash(
      char c
      )
      Description
      This call returns non-zero if c is \ or /.

      §4.3.2: char_to_upper

      char char_to_upper(
      char c
      )
      Description
      If c is a lowercase letter this call returns the uppercase equivalent, otherwise it returns c.

      §4.3.3: char_to_lower

      char char_to_lower(
      char c
      )
      Description
      If c is an uppercase letter this call returns the lowercase equivalent, otherwise it returns c.

      §4.3.4: char_is_whitespace

      fstr_bool char_is_whitespace(
      char c
      )
      Description
      This call returns non-zero if c is whitespace.

      §4.3.5: char_is_alpha_numeric

      fstr_bool char_is_alpha_numeric(
      char c
      )
      Description
      This call returns non-zero if c is any alphanumeric character including underscore.

      §4.3.6: char_is_alpha_numeric_true

      fstr_bool char_is_alpha_numeric_true(
      char c
      )
      Description
      This call returns non-zero if c is any alphanumeric character no including underscore.

      §4.3.7: char_is_alpha

      fstr_bool char_is_alpha(
      char c
      )
      Description
      This call returns non-zero if c is any alphabetic character including underscore.

      §4.3.8: char_is_alpha_true

      fstr_bool char_is_alpha_true(
      char c
      )
      Description
      This call returns non-zero if c is any alphabetic character.

      §4.3.9: char_is_hex

      fstr_bool char_is_hex(
      char c
      )
      Description
      This call returns non-zero if c is any valid hexadecimal digit.

      §4.3.10: char_is_numeric

      fstr_bool char_is_numeric(
      char c
      )
      Description
      This call returns non-zero if c is any valid decimal digit.

      §4.3.11: string_zero

      String string_zero(
      void
      )
      Description
      This call returns a String struct of zeroed members.

      §4.3.12: make_string_cap

      String make_string_cap(
      void *str,
      int32_t size,
      int32_t mem_size
      )
      Parameters
      str
      The str parameter provides the of memory with which the string shall operate.
      size
      The size parameter expresses the initial size of the string. If the memory does not already contain a useful string this should be zero.
      mem_size
      The mem_size parameter expresses the full size of the memory provided by str.
      Description
      This call returns the String created from the parameters.

      §4.3.13: make_string

      String make_string(
      void *str,
      int32_t size
      )
      Parameters
      str
      The str parameter provides the of memory with which the string shall operate.
      size
      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.
      Description
      This call returns the String created from the parameters.

      §4.3.14: make_lit_string

      #define make_lit_string(s)
      Description
      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.

      §4.3.15: make_fixed_width_string

      #define make_fixed_width_string(s)
      Description
      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.

      §4.3.16: expand_str

      #define expand_str(s)
      Description
      This macro is a helper for any calls that take a char*,integer pair to specify a string. This macro expands to both of those parameters from one String struct.

      §4.3.17: str_size

      int32_t str_size(
      char *str
      )
      Description
      This call returns the number of bytes before a null terminator starting at str.

      §4.3.18: make_string_slowly

      String make_string_slowly(
      void *str
      )
      Description
      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.

      §4.3.19: substr_tail

      String substr_tail(
      String str,
      int32_t start
      )
      Description
      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.

      §4.3.20: substr

      String substr(
      String str,
      int32_t start,
      int32_t size
      )
      Description
      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.

      §4.3.21: skip_whitespace

      String skip_whitespace(
      String str
      )
      Description
      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.
      See Also

      §4.3.22: chop_whitespace

      String chop_whitespace(
      String str
      )
      Description
      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.
      See Also

      §4.3.23: skip_chop_whitespace

      String skip_chop_whitespace(
      String str
      )
      Description
      This call is equivalent to calling skip_whitespace and chop_whitespace together.
      See Also

      §4.3.24: tailstr

      String tailstr(
      String str
      )
      Description
      This call returns an empty String with underlying memory taken from the portion of str's memory that is not used.

      §4.3.25: match_cc

      fstr_bool match_cc(
      char *a,
      char *b
      )
      Description
      This call returns non-zero if a and b are equivalent.

      §4.3.26: match_sc

      fstr_bool match_sc(
      String a,
      char *b
      )
      Description
      This call returns non-zero if a and b are equivalent.

      §4.3.27: match_cs

      fstr_bool match_cs(
      char *a,
      String b
      )
      Description
      This call returns non-zero if a and b are equivalent.

      §4.3.28: match_ss

      fstr_bool match_ss(
      String a,
      String b
      )
      Description
      This call returns non-zero if a and b are equivalent.

      §4.3.29: match_part_ccl

      fstr_bool match_part_ccl(
      char *a,
      char *b,
      int32_t *len
      )
      Parameters
      len
      If this call returns non-zero this parameter is used to output the length of b.
      Description
      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.

      §4.3.30: match_part_scl

      fstr_bool match_part_scl(
      String a,
      char *b,
      int32_t *len
      )
      Parameters
      len
      If this call returns non-zero this parameter is used to output the length of b.
      Description
      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.

      §4.3.31: match_part_cc

      fstr_bool match_part_cc(
      char *a,
      char *b
      )
      Parameters
      len
      If this call returns non-zero this parameter is used to output the length of b.
      Description
      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.

      §4.3.32: match_part_sc

      fstr_bool match_part_sc(
      String a,
      char *b
      )
      Description
      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.

      §4.3.33: match_part_cs

      fstr_bool match_part_cs(
      char *a,
      String b
      )
      Description
      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.

      §4.3.34: match_part_ss

      fstr_bool match_part_ss(
      String a,
      String b
      )
      Description
      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.

      §4.3.35: match_insensitive_cc

      fstr_bool match_insensitive_cc(
      char *a,
      char *b
      )
      Description
      This call returns non-zero if a and b are equivalent under case insensitive comparison.

      §4.3.36: match_insensitive_sc

      fstr_bool match_insensitive_sc(
      String a,
      char *b
      )
      Description
      This call returns non-zero if a and b are equivalent under case insensitive comparison.

      §4.3.37: match_insensitive_cs

      fstr_bool match_insensitive_cs(
      char *a,
      String b
      )
      Description
      This call returns non-zero if a and b are equivalent under case insensitive comparison.

      §4.3.38: match_insensitive_ss

      fstr_bool match_insensitive_ss(
      String a,
      String b
      )
      Description
      This call returns non-zero if a and b are equivalent under case insensitive comparison.

      §4.3.39: match_part_insensitive_ccl

      fstr_bool match_part_insensitive_ccl(
      char *a,
      char *b,
      int32_t *len
      )
      Parameters
      len
      If this call returns non-zero this parameter is used to output the length of b.
      Description
      This call performs the same partial matching rule as match_part under case insensitive comparison.
      See Also

      §4.3.40: match_part_insensitive_scl

      fstr_bool match_part_insensitive_scl(
      String a,
      char *b,
      int32_t *len
      )
      Parameters
      len
      If this call returns non-zero this parameter is used to output the length of b.
      Description
      This call performs the same partial matching rule as match_part under case insensitive comparison.
      See Also

      §4.3.41: match_part_insensitive_cc

      fstr_bool match_part_insensitive_cc(
      char *a,
      char *b
      )
      Description
      This call performs the same partial matching rule as match_part under case insensitive comparison.
      See Also

      §4.3.42: match_part_insensitive_sc

      fstr_bool match_part_insensitive_sc(
      String a,
      char *b
      )
      Description
      This call performs the same partial matching rule as match_part under case insensitive comparison.
      See Also

      §4.3.43: match_part_insensitive_cs

      fstr_bool match_part_insensitive_cs(
      char *a,
      String b
      )
      Description
      This call performs the same partial matching rule as match_part under case insensitive comparison.
      See Also

      §4.3.44: match_part_insensitive_ss

      fstr_bool match_part_insensitive_ss(
      String a,
      String b
      )
      Description
      This call performs the same partial matching rule as match_part under case insensitive comparison.
      See Also

      §4.3.45: compare_cc

      int32_t compare_cc(
      char *a,
      char *b
      )
      Description
      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.

      §4.3.46: compare_sc

      int32_t compare_sc(
      String a,
      char *b
      )
      Description
      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.

      §4.3.47: compare_cs

      int32_t compare_cs(
      char *a,
      String b
      )
      Description
      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.

      §4.3.48: compare_ss

      int32_t compare_ss(
      String a,
      String b
      )
      Description
      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.

      §4.3.49: find_c_char

      int32_t find_c_char(
      char *str,
      int32_t start,
      char character
      )
      Parameters
      str
      The str parameter provides a null terminated string to search.
      start
      The start parameter provides the index of the first character in str to search.
      character
      The character parameter provides the character for which to search.
      Description
      This call returns the index of the first occurance of character, or the size of the string if the character is not found.

      §4.3.50: find_s_char

      int32_t find_s_char(
      String str,
      int32_t start,
      char character
      )
      Parameters
      str
      The str parameter provides a string to search.
      start
      The start parameter provides the index of the first character in str to search.
      character
      The character parameter provides the character for which to search.
      Description
      This call returns the index of the first occurance of character, or the size of the string if the character is not found.

      §4.3.51: rfind_s_char

      int32_t rfind_s_char(
      String str,
      int32_t start,
      char character
      )
      Parameters
      str
      The str parameter provides a string to search.
      start
      The start parameter provides the index of the first character in str to search.
      character
      The character parameter provides the character for which to search.
      Description
      This call looks for the largest index less than or equal to the start position where the given character occurs. If the index is found it is returned otherwise -1 is returned.

      §4.3.52: find_c_chars

      int32_t find_c_chars(
      char *str,
      int32_t start,
      char *characters
      )
      Parameters
      str
      The str parameter provides a null terminated string to search.
      start
      The start parameter provides the index of the first character in str to search.
      character
      The characters parameter provides a null terminated array of characters for which to search.
      Description
      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.

      §4.3.53: find_s_chars

      int32_t find_s_chars(
      String str,
      int32_t start,
      char *characters
      )
      Parameters
      str
      The str parameter provides a string to search.
      start
      The start parameter provides the index of the first character in str to search.
      character
      The characters parameter provides a null terminated array of characters for which to search.
      Description
      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.

      §4.3.54: find_substr_c

      int32_t find_substr_c(
      char *str,
      int32_t start,
      String seek
      )
      Parameters
      str
      The str parameter provides a null terminated string to search.
      start
      The start parameter provides the index of the first character in str to search.
      seek
      The seek parameter provides a string to find in str.
      Description
      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.

      §4.3.55: find_substr_s

      int32_t find_substr_s(
      String str,
      int32_t start,
      String seek
      )
      Parameters
      str
      The str parameter provides a string to search.
      start
      The start parameter provides the index of the first character in str to search.
      seek
      The seek parameter provides a string to find in str.
      Description
      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.

      §4.3.56: rfind_substr_s

      int32_t rfind_substr_s(
      String str,
      int32_t start,
      String seek
      )
      Parameters
      str
      The str parameter provides a string to search.
      start
      The start parameter provides the index of the first character in str to search.
      seek
      The seek parameter provides a string to find in str.
      Description
      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.

      §4.3.57: find_substr_insensitive_c

      int32_t find_substr_insensitive_c(
      char *str,
      int32_t start,
      String seek
      )
      Parameters
      str
      The str parameter provides a null terminated string to search.
      start
      The start parameter provides the index of the first character in str to search.
      seek
      The seek parameter provides a string to find in str.
      Description
      This call acts as find_substr under case insensitive comparison.
      See Also

      §4.3.58: find_substr_insensitive_s

      int32_t find_substr_insensitive_s(
      String str,
      int32_t start,
      String seek
      )
      Parameters
      str
      The str parameter provides a string to search.
      start
      The start parameter provides the index of the first character in str to search.
      seek
      The seek parameter provides a string to find in str.
      Description
      This call acts as find_substr under case insensitive comparison.
      See Also

      §4.3.59: has_substr_c

      fstr_bool has_substr_c(
      char *s,
      String seek
      )
      Description
      This call returns non-zero if the string s contains a substring equivalent to seek.

      §4.3.60: has_substr_s

      fstr_bool has_substr_s(
      String s,
      String seek
      )
      Description
      This call returns non-zero if the string s contains a substring equivalent to seek.

      §4.3.61: has_substr_insensitive_c

      fstr_bool has_substr_insensitive_c(
      char *s,
      String seek
      )
      Description
      This call returns non-zero if the string s contains a substring equivalent to seek under case insensitive comparison.

      §4.3.62: has_substr_insensitive_s

      fstr_bool has_substr_insensitive_s(
      String s,
      String seek
      )
      Description
      This call returns non-zero if the string s contains a substring equivalent to seek under case insensitive comparison.

      §4.3.63: copy_fast_unsafe_cc

      int32_t copy_fast_unsafe_cc(
      char *dest,
      char *src
      )
      Description
      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.

      §4.3.64: copy_fast_unsafe_cs

      int32_t copy_fast_unsafe_cs(
      char *dest,
      String src
      )
      Description
      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.

      §4.3.65: copy_checked_ss

      fstr_bool copy_checked_ss(
      String *dest,
      String src
      )
      Description
      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.

      §4.3.66: copy_partial_sc

      fstr_bool copy_partial_sc(
      String *dest,
      char *src
      )
      Description
      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.

      §4.3.67: copy_partial_ss

      fstr_bool copy_partial_ss(
      String *dest,
      String src
      )
      Description
      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.

      §4.3.68: copy_cc

      int32_t copy_cc(
      char *dest,
      char *src
      )
      Description
      This call performs a copy from src to dest equivalent to copy_fast_unsafe.
      See Also

      §4.3.69: copy_ss

      void copy_ss(
      String *dest,
      String src
      )
      Description
      This call performs a copy from src to dest equivalent to copy_checked.
      See Also

      §4.3.70: copy_sc

      void copy_sc(
      String *dest,
      char *src
      )
      Description
      This call performs a copy from src to dest equivalent to copy_partial.
      See Also

      §4.3.71: append_checked_ss

      fstr_bool append_checked_ss(
      String *dest,
      String src
      )
      Description
      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.

      §4.3.72: append_partial_sc

      fstr_bool append_partial_sc(
      String *dest,
      char *src
      )
      Description
      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.

      §4.3.73: append_partial_ss

      fstr_bool append_partial_ss(
      String *dest,
      String src
      )
      Description
      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.

      §4.3.74: append_s_char

      fstr_bool append_s_char(
      String *dest,
      char c
      )
      Description
      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.

      §4.3.75: append_ss

      fstr_bool append_ss(
      String *dest,
      String src
      )
      Description
      This call is equivalent to append_partial.
      See Also

      §4.3.76: append_sc

      fstr_bool append_sc(
      String *dest,
      char *src
      )
      Description
      This call is equivalent to append_partial.
      See Also

      §4.3.77: terminate_with_null

      fstr_bool terminate_with_null(
      String *str
      )
      Description
      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.

      §4.3.78: append_padding

      fstr_bool append_padding(
      String *dest,
      char c,
      int32_t target_size
      )
      Description
      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.

      §4.3.79: replace_char

      void replace_char(
      String *str,
      char replace,
      char with
      )
      Parameters
      str
      The str parameter provides the string in which replacement shall be performed.
      replace
      The replace character specifies which character should be replaced.
      with
      The with character specifies what to write into the positions where replacement occurs.
      Description
      This call replaces all occurances of character in str with another character.

      §4.3.80: to_lower_cc

      void to_lower_cc(
      char *src,
      char *dst
      )
      Parameters
      src
      The source string to conver to lowercase. This string must be null terminated.
      dst
      The destination buffer to receive the converted string. This must be large enough to contain all of src and a null terminator.
      Description
      Rewrites the string in src into dst with all letters lowercased. src and dst should not overlap with the exception that src and dst may be exactly equal in order to convert the string in place.

      §4.3.81: to_lower_ss

      void to_lower_ss(
      String *src,
      String *dst
      )
      Parameters
      src
      The source string to conver to lowercase.
      dst
      The destination buffer to receive the converted string. This must have a capacity of at least the size of src.
      Description
      Rewrites the string in src into dst. src and dst should not overlap with the exception that src and dst may be exactly equal in order to convert the string in place.

      §4.3.82: to_lower_s

      void to_lower_s(
      String *str
      )
      Parameters
      str
      The string to be converted to all lowercase.
      Description
      This version of to_lower converts str to lowercase in place.

      §4.3.83: to_upper_cc

      void to_upper_cc(
      char *src,
      char *dst
      )
      Parameters
      src
      The source string to convert to uppercase. This string must be null terminated.
      dst
      The destination buffer to receive the converted string. This must be large enough to contain all of src and a null terminator.
      Description
      Rewrites the string in src into dst. src and dst should not overlap with the exception that src and dst may be exactly equal in order to convert the string in place.

      §4.3.84: to_upper_ss

      void to_upper_ss(
      String *src,
      String *dst
      )
      Parameters
      src
      The source string to conver to uppercase.
      dst
      The destination buffer to receive the converted string. This must have a capacity of at least the size of src.
      Description
      Rewrites the string in src into dst. src and dst should not overlap with the exception that src and dst may be exactly equal in order to convert the string in place.

      §4.3.85: to_upper_s

      void to_upper_s(
      String *str
      )
      Parameters
      str
      The string to be converted to all uppercase.
      Description
      This version of to_upper converts str to uppercase in place.

      §4.3.86: int_to_str_size

      int32_t int_to_str_size(
      int32_t x
      )
      Description
      This call returns the number of bytes required to represent x as a string.

      §4.3.87: int_to_str

      fstr_bool int_to_str(
      String *dest,
      int32_t x
      )
      Description
      This call writes a string representation of x into dest. If there is enough space in dest this call returns non-zero.

      §4.3.88: append_int_to_str

      fstr_bool append_int_to_str(
      String *dest,
      int32_t x
      )
      Description
      This call appends a string representation of x onto dest. If there is enough space in dest this call returns non-zero.

      §4.3.89: u64_to_str_size

      int32_t u64_to_str_size(
      uint64_t x
      )
      Description
      This call returns the number of bytes required to represent x as a string.

      §4.3.90: u64_to_str

      fstr_bool u64_to_str(
      String *dest,
      uint64_t x
      )
      Description
      This call writes a string representation of x into dest. If there is enough space in dest this call returns non-zero.

      §4.3.91: append_u64_to_str

      fstr_bool append_u64_to_str(
      String *dest,
      uint64_t x
      )
      Description
      This call appends a string representation of x onto dest. If there is enough space in dest this call returns non-zero.

      §4.3.92: float_to_str_size

      int32_t float_to_str_size(
      float x
      )
      Description
      This call returns the number of bytes required to represent x as a string.

      §4.3.93: append_float_to_str

      fstr_bool append_float_to_str(
      String *dest,
      float x
      )
      Description
      This call writes a string representation of x into dest. If there is enough space in dest this call returns non-zero.

      §4.3.94: float_to_str

      fstr_bool float_to_str(
      String *dest,
      float x
      )
      Description
      This call appends a string representation of x onto dest. If there is enough space in dest this call returns non-zero.

      §4.3.95: str_is_int_c

      int32_t str_is_int_c(
      char *str
      )
      Description
      If str is a valid string representation of an integer, this call returns non-zero

      §4.3.96: str_is_int_s

      fstr_bool str_is_int_s(
      String str
      )
      Description
      If str is a valid string representation of an integer, this call returns non-zero.

      §4.3.97: str_to_int_c

      int32_t str_to_int_c(
      char *str
      )
      Description
      If str is a valid string representation of an integer, this call will return the integer represented by the string. Otherwise this call returns zero.

      §4.3.98: str_to_int_s

      int32_t str_to_int_s(
      String str
      )
      Description
      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.

      §4.3.99: hexchar_to_int

      int32_t hexchar_to_int(
      char c
      )
      Description
      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.

      §4.3.100: int_to_hexchar

      char int_to_hexchar(
      int32_t x
      )
      Description
      If x is in the range [0,15] this call returns the equivalent lowercase hexadecimal digit. Otherwise the return is some nonsense value.

      §4.3.101: hexstr_to_int

      uint32_t hexstr_to_int(
      String str
      )
      Description
      This call interprets str has a hexadecimal representation of an integer and returns the represented integer value.

      §4.3.102: color_to_hexstr

      fstr_bool color_to_hexstr(
      String *s,
      uint32_t color
      )
      Description
      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.

      §4.3.103: hexstr_to_color

      fstr_bool hexstr_to_color(
      String s,
      uint32_t *out
      )
      Description
      This call interprets s as a color and writes the 32-bit integer representation into out.

      §4.3.104: reverse_seek_slash_pos

      int32_t reverse_seek_slash_pos(
      String str,
      int32_t pos
      )
      Description
      This call searches for a slash in str by starting pos bytes from the end and going backwards.

      §4.3.105: reverse_seek_slash

      int32_t reverse_seek_slash(
      String str
      )
      Description
      This call searches for a slash in str by starting at the end and going backwards.

      §4.3.106: front_of_directory

      String front_of_directory(
      String dir
      )
      Description
      This call returns a substring of dir containing only the file name or folder name furthest to the right in the directory.
      See Also

      §4.3.107: path_of_directory

      String path_of_directory(
      String dir
      )
      Description
      This call returns a substring of dir containing the whole path except for the final file or folder name.
      See Also

      §4.3.108: set_last_folder_sc

      fstr_bool set_last_folder_sc(
      String *dir,
      char *folder_name,
      char slash
      )
      Parameters
      dir
      The dir parameter is the directory string in which to set the last folder in the directory.
      folder_name
      The folder_name parameter is a null terminated string specifying the name to set at the end of the directory.
      slash
      The slash parameter specifies what slash to use between names in the directory.
      Description
      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.

      §4.3.109: set_last_folder_ss

      fstr_bool set_last_folder_ss(
      String *dir,
      String folder_name,
      char slash
      )
      Parameters
      dir
      The dir parameter is the directory string in which to set the last folder in the directory.
      folder_name
      The folder_name parameter is a string specifying the name to set at the end of the directory.
      slash
      The slash parameter specifies what slash to use between names in the directory.
      Description
      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.

      §4.3.110: file_extension

      String file_extension(
      String str
      )
      Description
      This call returns a substring containing only the file extension of the provided filename.
      See Also

      §4.3.111: remove_extension

      fstr_bool remove_extension(
      String *str
      )
      Description
      This call attemps to delete a file extension off the end of a filename. This call returns non-zero on success.

      §4.3.112: remove_last_folder

      fstr_bool remove_last_folder(
      String *str
      )
      Description
      This call attemps to delete a folder or filename off the end of a path string. This call returns non-zero on success.

      §4.3.113: string_set_match

      fstr_bool string_set_match(
      String *str_set,
      int32_t count,
      String str,
      int32_t *match_index
      )
      Parameters
      str_set
      The str_set parameter is an array of String structs specifying matchable strings.
      count
      The count parameter specifies the number of String structs in the str_set array.
      str
      The str parameter specifies the string to match against the str_set.
      match_index
      If this call succeeds match_index is filled with the index into str_set where the match occurred.
      Description
      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.
      See Also