§2.2.0: exec_command
void exec_command(Application_Links *app, int command_id)
@@ -170,7 +170,7 @@ DOC_PARAM(command_id, an integer id enumerated in 4coder_custom.h starting with
DOC(Executes the command associated with the command_id passed in)
+
§2.2.1: exec_system_command
int exec_system_command(Application_Links *app, View_Summary *view, Buffer_Identifier buffer, char *path, int path_len, char *command, int command_len, unsigned int flags)
@@ -203,87 +203,8 @@ of at the beginning.
)
-
-
§2.2.2: directory_get_hot
-
int directory_get_hot(Application_Links *app, char *out, int capacity)
-
-DOC_PARAM(out, a buffer that receives the 4coder 'hot directory')
-DOC_PARAM(capacity, the maximum size to be output to the output buffer)
-DOC_RETURN(returns the size of the string written into the buffer)
-DOC
-(
-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 by the custom side.
-)
-
-
-
-
§2.2.3: get_4ed_path
-
int get_4ed_path(Application_Links *app, char *out, int capacity)
-
-DOC_PARAM(out, a buffer that receives the path to the 4ed executable file)
-DOC_PARAM(capacity, the maximum capacity of the output buffer)
-DOC_RETURN(returns non-zero on success, returns zero on failure)
-
-
-
-
§2.2.4: file_exists
-
int file_exists(Application_Links *app, char *filename, int len)
-
-DOC_PARAM(filename, the full path to a file)
-DOC_PARAM(len, the number of characters in the filename string)
-DOC_RETURN(returns non-zero if the file exists, returns zero if the file does not exist)
-
-
-
-
§2.2.5: directory_cd
-
int directory_cd(Application_Links *app, char *dir, int *len, int capacity, char *rel_path, int rel_len)
-
-DOC_PARAM(dir, a string buffer containing a directory)
-DOC_PARAM(len, the length of the string in the string buffer)
-DOC_PARAM(capacity, the maximum size of the string buffer)
-DOC_PARAM(rel_path, the path to change to, may include '.' or '..')
-DOC_PARAM(rel_len, the length of the rel_path string)
-DOC_RETURN(returns non-zero if the call succeeds, returns zero otherwise)
-DOC
-(
-This call succeeds if the directory exists and the new directory fits inside the dir buffer.
-If the call succeeds the dir buffer is filled with the new directory and len contains the
-length of the 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 as ".." to traverse to parent folders.
-)
-
-
-
-
§2.2.6: get_file_list
-
File_List get_file_list(Application_Links *app, char *dir, int len)
-
-DOC_PARAM(dir, the directory whose files will be enumerated in the returned list)
-DOC_PARAM(len, the length of the dir string)
-DOC_RETURN
-(
-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.
-)
-
-
-
-
§2.2.7: free_file_list
-
void free_file_list(Application_Links *app, File_List list)
-
-DOC_PARAM(list, the file list to be freed)
-DOC(after this call the file list passed in should not be read or written to)
-
-
-
-
§2.2.8: clipboard_post
+
+
§2.2.2: clipboard_post
void clipboard_post(Application_Links *app, char *str, int len)
DOC_PARAM(str, the string to post to the clipboard)
@@ -296,15 +217,15 @@ be pasted into other applications.
)
-
-
§2.2.9: clipboard_count
+
+
§2.2.3: clipboard_count
int clipboard_count(Application_Links *app)
DOC(returns the number of items in the clipboard)
-
-
§2.2.10: clipboard_index
+
+
§2.2.4: clipboard_index
int clipboard_index(Application_Links *app, int index, char *out, int len)
DOC_PARAM(index, the index of the item to be read)
@@ -323,8 +244,8 @@ string is not null terminated.
)
-
-
§2.2.11: get_buffer_first
+
+
§2.2.5: get_buffer_first
Buffer_Summary get_buffer_first(Application_Links *app, unsigned int access)
DOC_PARAM(access, the access flags for the access)
@@ -340,8 +261,8 @@ DOC_SEE(Access_Flag)
DOC_SEE(get_buffer_next)
-
-
§2.2.12: get_buffer_next
+
+
§2.2.6: get_buffer_next
void get_buffer_next(Application_Links *app, Buffer_Summary *buffer, unsigned int access)
DOC_PARAM(buffer, pointer to the loop buffer originally returned by get_buffer_first)
@@ -359,8 +280,8 @@ DOC_SEE(Access_Flag)
DOC_SEE(get_buffer_first)
-
-
§2.2.13: get_buffer
+
+
§2.2.7: get_buffer
Buffer_Summary get_buffer(Application_Links *app, int buffer_id, unsigned int access)
DOC_PARAM(buffer_id, the id of the buffer to get)
@@ -368,8 +289,8 @@ DOC_PARAM(access, the access flags for the access)
DOC_RETURN(returns a summary that describes the indicated buffer if it exists and is accessible)
-
-
§2.2.14: get_buffer_by_name
+
+
§2.2.8: get_buffer_by_name
Buffer_Summary get_buffer_by_name(Application_Links *app, char *name, int len, unsigned int access)
DOC_PARAM(name, the name of the buffer)
@@ -378,9 +299,9 @@ DOC_PARAM(access, the access flags for the access)
DOC_RETURN(returns a summary that describes the indicated buffer if it exists and is accessible)
-
-
§2.2.15: buffer_seek
-
int buffer_seek(Application_Links *app, Buffer_Summary *buffer, int start_pos, int seek_forward, unsigned int flags)
+
+
§2.2.9: buffer_boundary_seek
+
int buffer_boundary_seek(Application_Links *app, Buffer_Summary *buffer, int start_pos, int seek_forward, unsigned int flags)
DOC_PARAM(buffer, the buffer to seek through)
DOC_PARAM(start_pos, the absolute position in the buffer to begin the seek)
@@ -390,8 +311,8 @@ DOC_RETURN(returns the position where the seek stops)
DOC_SEE(Seek_Boundary_Flag)
-
-
§2.2.16: buffer_read_range
+
+
§2.2.10: buffer_read_range
int buffer_read_range(Application_Links *app, Buffer_Summary *buffer, int start, int end, char *out)
DOC_PARAM(buffer, the buffer to read out of)
@@ -409,8 +330,8 @@ is not within the bounds of the buffer.
)
-
-
§2.2.17: buffer_replace_range
+
+
§2.2.11: buffer_replace_range
int buffer_replace_range(Application_Links *app, Buffer_Summary *buffer, int start, int end, char *str, int len)
DOC_PARAM(buffer, the buffer to edit)
@@ -432,8 +353,8 @@ range is not within the bounds of the buffer.
)
-
-
§2.2.18: buffer_set_setting
+
+
§2.2.12: buffer_set_setting
int buffer_set_setting(Application_Links *app, Buffer_Summary *buffer, int setting, int value)
DOC_PARAM(buffer, the buffer to set a setting on)
@@ -442,8 +363,8 @@ DOC_PARAM(value, the value to set the specified setting to)
DOC_SEE(Buffer_Setting_ID)
-
-
§2.2.19: buffer_auto_indent
+
+
§2.2.13: buffer_auto_indent
int buffer_auto_indent(Application_Links *app, Buffer_Summary *buffer, int start, int end, int tab_width, unsigned int flags)
DOC_PARAM(buffer, the buffer in which to apply the auto indenting)
@@ -462,8 +383,8 @@ completed this function will fail.
DOC_SEE(Auto_Tab_Flag)
-
-
§2.2.20: create_buffer
+
+
§2.2.14: create_buffer
Buffer_Summary create_buffer(Application_Links *app, char *filename, int filename_len, unsigned int flags)
DOC_PARAM(filename, the name of the file to be opened or created)
@@ -481,8 +402,8 @@ the filename does not correspond to a file on disk the buffer is created empty.
DOC_SEE(Buffer_Create_Flag)
-
-
§2.2.21: save_buffer
+
+
§2.2.15: save_buffer
int save_buffer(Application_Links *app, Buffer_Summary *buffer, char *filename, int filename_len, unsigned int flags)
DOC_PARAM(buffer, the buffer to save to a file)
@@ -492,8 +413,8 @@ DOC_PARAM(flags, not currently used)
DOC_RETURN(returns non-zero if the save succeeds)
-
-
§2.2.22: kill_buffer
+
+
§2.2.16: kill_buffer
int kill_buffer(Application_Links *app, Buffer_Identifier buffer, int view_id, unsigned int flags)
DOC_PARAM(buffer, a buffer identifier specifying the buffer to try to kill)
@@ -509,8 +430,8 @@ If the view is not open the kill fails.
DOC_SEE(Buffer_Kill_Flags)
-
-
§2.2.23: get_view_first
+
+
§2.2.17: get_view_first
View_Summary get_view_first(Application_Links *app, unsigned int access)
DOC_PARAM(access, the access flags for the access)
@@ -526,8 +447,8 @@ DOC_SEE(Access_Flag)
DOC_SEE(get_view_next)
-
-
§2.2.24: get_view_next
+
+
§2.2.18: get_view_next
void get_view_next(Application_Links *app, View_Summary *view, unsigned int access)
DOC_PARAM(view, pointer to the loop view originally returned by get_view_first)
@@ -545,8 +466,8 @@ DOC_SEE(Access_Flag)
DOC_SEE(get_view_first)
-
-
§2.2.25: get_view
+
+
§2.2.19: get_view
View_Summary get_view(Application_Links *app, int view_id, unsigned int access)
DOC_PARAM(view_id, the id of the view to get)
@@ -554,16 +475,16 @@ DOC_PARAM(access, the access flags for the access)
DOC_RETURN(returns a summary that describes the indicated view if it is open and is accessible)
-
-
§2.2.26: get_active_view
+
+
§2.2.20: get_active_view
View_Summary get_active_view(Application_Links *app, unsigned int access)
DOC_PARAM(access, the access flags for the access)
DOC_RETURN(returns a summary that describes the active view)
-
-
§2.2.27: view_compute_cursor
+
+
§2.2.21: view_compute_cursor
int view_compute_cursor(Application_Links *app, View_Summary *view, Buffer_Seek seek, Full_Cursor *cursor_out)
DOC_PARAM(view, the view on which to run the cursor computation)
@@ -577,8 +498,8 @@ Computes a full cursor for the given seek position.
DOC_SEE(Buffer_Seek)
-
-
§2.2.28: view_set_cursor
+
+
§2.2.22: view_set_cursor
int view_set_cursor(Application_Links *app, View_Summary *view, Buffer_Seek seek, int set_preferred_x)
DOC_PARAM(view, the view in which to set the cursor)
@@ -593,8 +514,8 @@ cursor position is is a vertical motion that tries to keep the cursor in the sam
DOC_SEE(Buffer_Seek)
-
-
§2.2.29: view_set_mark
+
+
§2.2.23: view_set_mark
int view_set_mark(Application_Links *app, View_Summary *view, Buffer_Seek seek)
DOC_PARAM(view, the view in which to set the mark)
@@ -607,8 +528,8 @@ Sets the the view's mark position.
DOC_SEE(Buffer_Seek)
-
-
§2.2.30: view_set_highlight
+
+
§2.2.24: view_set_highlight
int view_set_highlight(Application_Links *app, View_Summary *view, int start, int end, int turn_on)
DOC_PARAM(view, the view to set the highlight in)
@@ -625,8 +546,8 @@ the turn_on set to false, will switch back to showing the cursor.
)
-
-
§2.2.31: view_set_buffer
+
+
§2.2.25: view_set_buffer
int view_set_buffer(Application_Links *app, View_Summary *view, int buffer_id, unsigned int flags)
DOC_PARAM(view, the view to display the buffer in)
@@ -641,8 +562,8 @@ cancels and dialogue shown in the view and displays the file.
DOC_SEE(Set_Buffer_Flag)
-
-
§2.2.32: view_post_fade
+
+
§2.2.26: view_post_fade
int view_post_fade(Application_Links *app, View_Summary *view, float seconds, int start, int end, unsigned int color)
DOC_PARAM(view, the veiw to post a fade effect to)
@@ -652,18 +573,18 @@ DOC_PARAM(end, one after the last character in the fade range)
DOC_PARAM(color, the color to fade from)
-
-
§2.2.33: view_set_paste_rewrite_
+
+
§2.2.27: view_set_paste_rewrite_
void view_set_paste_rewrite_(Application_Links *app, View_Summary *view)
No doc generated ~ assume this call is not meant to be public
-
-
§2.2.34: view_get_paste_rewrite_
+
+
§2.2.28: view_get_paste_rewrite_
int view_get_paste_rewrite_(Application_Links *app, View_Summary *view)
No doc generated ~ assume this call is not meant to be public
-
-
§2.2.35: get_user_input
+
-
-
§2.2.36: get_command_input
+
-
-
§2.2.37: get_mouse_state
+
+
§2.2.31: get_mouse_state
Mouse_State get_mouse_state(Application_Links *app)
DOC_RETURN(returns the current mouse state)
DOC_SEE(Mouse_State)
-
-
§2.2.38: start_query_bar
+
+
§2.2.32: start_query_bar
int start_query_bar(Application_Links *app, Query_Bar *bar, unsigned int flags)
DOC_PARAM(bar, a pointer to the Query_Bar struct that defines the bar's contents)
@@ -711,8 +632,8 @@ until the command returns.
)
-
-
§2.2.39: end_query_bar
+
+
§2.2.33: end_query_bar
void end_query_bar(Application_Links *app, Query_Bar *bar, unsigned int flags)
DOC_PARAM(bar, a pointer to the Query_Bar struct to end)
@@ -723,32 +644,32 @@ bar must be a pointer previously passed to start_query_bar previously in the sam
)
-
-
§2.2.40: print_message
+
+
§2.2.34: print_message
void print_message(Application_Links *app, char *str, int len)
DOC_PARAM(str, the string to post to *messages*)
DOC_PARAM(len, the length of str string)
-
-
§2.2.41: change_theme
+
+
§2.2.35: change_theme
void change_theme(Application_Links *app, char *name, int len)
DOC_PARAM(name, the name of the built in theme to change to)
DOC_PARAM(len, the length of the name string)
-
-
§2.2.42: change_font
+
+
§2.2.36: change_font
void change_font(Application_Links *app, char *name, int len)
DOC_PARAM(name, the name of the built in font to change to)
DOC_PARAM(len, the length of the name string)
-
-
§2.2.43: set_theme_colors
+
+
§2.2.37: set_theme_colors
void set_theme_colors(Application_Links *app, Theme_Color *colors, int count)
DOC_PARAM(colors, an array of color structs pairing differet style tags to color codes)
@@ -760,8 +681,8 @@ code paired with the tag.
)
-
-
§2.2.44: get_theme_colors
+
+
§2.2.38: get_theme_colors
void get_theme_colors(Application_Links *app, Theme_Color *colors, int count)
DOC_PARAM(colors, an array of color structs listing style tags to get color values for)
@@ -773,6 +694,85 @@ color from the specified color in the pallet.
)
+
+
§2.2.39: directory_get_hot
+
int directory_get_hot(Application_Links *app, char *out, int capacity)
+
+DOC_PARAM(out, a buffer that receives the 4coder 'hot directory')
+DOC_PARAM(capacity, the maximum size to be output to the output buffer)
+DOC_RETURN(returns the size of the string written into the buffer)
+DOC
+(
+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 by the custom side.
+)
+
+
+
+
§2.2.40: get_file_list
+
File_List get_file_list(Application_Links *app, char *dir, int len)
+
+DOC_PARAM(dir, the directory whose files will be enumerated in the returned list)
+DOC_PARAM(len, the length of the dir string)
+DOC_RETURN
+(
+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.
+)
+
+
+
+
§2.2.41: free_file_list
+
void free_file_list(Application_Links *app, File_List list)
+
+DOC_PARAM(list, the file list to be freed)
+DOC(after this call the file list passed in should not be read or written to)
+
+
+
+
§2.2.42: file_exists
+
int file_exists(Application_Links *app, char *filename, int len)
+
+DOC_PARAM(filename, the full path to a file)
+DOC_PARAM(len, the number of characters in the filename string)
+DOC_RETURN(returns non-zero if the file exists, returns zero if the file does not exist)
+
+
+
+
§2.2.43: directory_cd
+
int directory_cd(Application_Links *app, char *dir, int *len, int capacity, char *rel_path, int rel_len)
+
+DOC_PARAM(dir, a string buffer containing a directory)
+DOC_PARAM(len, the length of the string in the string buffer)
+DOC_PARAM(capacity, the maximum size of the string buffer)
+DOC_PARAM(rel_path, the path to change to, may include '.' or '..')
+DOC_PARAM(rel_len, the length of the rel_path string)
+DOC_RETURN(returns non-zero if the call succeeds, returns zero otherwise)
+DOC
+(
+This call succeeds if the directory exists and the new directory fits inside the dir buffer.
+If the call succeeds the dir buffer is filled with the new directory and len contains the
+length of the 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.
+)
+
+
+
+
§2.2.44: get_4ed_path
+
int get_4ed_path(Application_Links *app, char *out, int capacity)
+
+DOC_PARAM(out, a buffer that receives the path to the 4ed executable file)
+DOC_PARAM(capacity, the maximum capacity of the output buffer)
+DOC_RETURN(returns non-zero on success, returns zero on failure)
+
+