Skip to content

Cleanup enums #450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RandyGaul merged 2 commits into from
Jan 26, 2026
Merged

Cleanup enums #450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff54772
Ensure enums are prefixed with `CF_`
pusewicz Jan 26, 2026
2d8b127
Make values monospace
pusewicz Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions include/cute_app.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ CF_API CF_DisplayOrientation CF_CALL cf_display_orientation(CF_DisplayID display
* app_destroy();
* return 0;
* }
* @remarks The `app_options` parameter of `cf_make_app` is a bitmask flag. Simply take the `APP_OPTIONS_*` flags listed above and OR them together.
* @remarks The `app_options` parameter of `cf_make_app` is a bitmask flag. Simply take the `CF_APP_OPTIONS_*` flags listed above and OR them together.
* @related CF_AppOptionFlagBits cf_make_app cf_destroy_app
*/
#define CF_APP_OPTION_DEFS \
Expand Down Expand Up @@ -245,7 +245,7 @@ typedef enum CF_AppOptionFlagBits
* return 0;
* }
* @remarks The options parameter is an enum from `app_options`. Different options can be OR'd together.
* Parameters `w` and `h` are ignored if the window is initialized to fullscreen mode with `APP_OPTIONS_FULLSCREEN`.
* Parameters `w` and `h` are ignored if the window is initialized to fullscreen mode with `CF_APP_OPTIONS_FULLSCREEN_BIT`.
* @related CF_AppOptionFlagBits cf_app_is_running cf_app_signal_shutdown cf_destroy_app
*/
CF_API CF_Result CF_CALL cf_make_app(const char* window_title, CF_DisplayID display_id, int x, int y, int w, int h, CF_AppOptionFlags options, const char* argv0);
Expand All @@ -270,7 +270,7 @@ CF_API void CF_CALL cf_destroy_app(void);
* int main(int argc, const char** argv)
* {
* // Create a window with a resolution of 640 x 480, along with a DirectX 11 context.
* app_make("Fancy Window Title", 0, 50, 50, 640, 480, CF_APP_OPTIONS_D3D11_CONTEXT, argv[0]);
* app_make("Fancy Window Title", 0, 50, 50, 640, 480, CF_APP_OPTIONS_GFX_D3D11_BIT, argv[0]);
*
* while (app_is_running())
* {
Expand Down Expand Up @@ -301,7 +301,7 @@ CF_API bool CF_CALL cf_app_is_running(void);
* int main(int argc, const char** argv)
* {
* // Create a window with a resolution of 640 x 480, along with a DirectX 11 context.
* app_make("Fancy Window Title", 0, 50, 50, 640, 480, CF_APP_OPTIONS_D3D11_CONTEXT, argv[0]);
* app_make("Fancy Window Title", 0, 50, 50, 640, 480, CF_APP_OPTIONS_GFX_D3D11_BIT, argv[0]);
*
* while (app_is_running())
* {
Expand Down Expand Up @@ -343,7 +343,7 @@ CF_API void CF_CALL cf_app_update(CF_OnUpdateFn* on_update);
* int main(int argc, const char** argv)
* {
* // Create a window with a resolution of 640 x 480, along with a DirectX 11 context.
* app_make("Fancy Window Title", 0, 50, 50, 640, 480, CF_APP_OPTIONS_D3D11_CONTEXT, argv[0]);
* app_make("Fancy Window Title", 0, 50, 50, 640, 480, CF_APP_OPTIONS_GFX_D3D11_BIT, argv[0]);
*
* while (app_is_running())
* {
Expand Down
2 changes: 1 addition & 1 deletion include/cute_coroutine.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ typedef void (CF_CoroutineFn)(CF_Coroutine co);
* @param fn The entry point (function) the coroutine runs.
* @param stack_size The size of the coroutine's stack to call functions and make local variables, the default is about 57344 bytes.
* @param udata Can be `NULL`. Gets handed back to you when `cf_coroutine_get_udata` is called.
* @remarks The coroutine starts in a `COROUTINE_STATE_SUSPENDED`, and won't run until `cf_coroutine_resume` is first called. Free up the
* @remarks The coroutine starts in a `CF_COROUTINE_STATE_SUSPENDED`, and won't run until `cf_coroutine_resume` is first called. Free up the
* coroutine with `cf_destroy_coroutine` when done. See `CF_Coroutine` for some more details. **IMPORTANT NOTE**: You should beef
* up the stack_size to 1 or 2 MB (you may use e.g. `CF_MB * 2`) if you wish to call into APIs such as DirectX. A variety of APIs
* and libraries out there have very deep or complex call stacks -- so the default size may cause stack overflows in such cases.
Expand Down
4 changes: 2 additions & 2 deletions include/cute_file_system.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ CF_API char* CF_CALL cf_path_normalize(const char* path);
* a single file without overwriting each other on the actual disk.
*
* By default CF mounts the base directory when you call `make_app`. This can be disabled by
* passing the `APP_OPTIONS_FILE_SYSTEM_DONT_DEFAULT_MOUNT` flag to `make_app`.
* passing the `CF_APP_OPTIONS_FILE_SYSTEM_DONT_DEFAULT_MOUNT_BIT` flag to `cf_make_app`.
*/

/**
Expand Down Expand Up @@ -400,7 +400,7 @@ CF_API const char* CF_CALL cf_fs_get_user_directory(const char* company_name, co
* formats supported (see top of file).
*
* By default CF mounts the base directory when you call `cf_make_app`. This can be disabled by
* passing the `CF_APP_OPTIONS_FILE_SYSTEM_DONT_DEFAULT_MOUNT` flag to `cf_make_app`. [Virtual File System](https://randygaul.github.io/cute_framework/topics/virtual_file_system).
* passing the `CF_APP_OPTIONS_FILE_SYSTEM_DONT_DEFAULT_MOUNT_BIT` flag to `cf_make_app`. [Virtual File System](https://randygaul.github.io/cute_framework/topics/virtual_file_system).
* @related cf_fs_get_base_directory cf_fs_set_write_directory cf_fs_get_user_directory cf_fs_mount cf_fs_dismount
*/
CF_API CF_Result CF_CALL cf_fs_mount(const char* archive, const char* mount_point, bool append_to_path);
Expand Down
6 changes: 3 additions & 3 deletions samples/docs_parser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ void Doc::emit_params(FILE* fp)
if (param_names.count()) {
fprintf(fp, "Parameters | Description\n--- | ---\n");
for (int i = 0; i < param_names.count(); ++i) {
fprintf(fp, "%s | %s\n", param_names[i].c_str(), param_briefs[i].c_str());
fprintf(fp, "`%s` | %s\n", param_names[i].c_str(), param_briefs[i].c_str());
}
fprintf(fp, "\n");
}
Expand All @@ -240,7 +240,7 @@ void Doc::emit_enum_entries(FILE* fp)
fprintf(fp, "## Values\n\n");
fprintf(fp, "Enum | Description\n--- | ---\n");
for (int i = 0; i < enum_entries.count(); ++i) {
fprintf(fp, "%s | %s\n", enum_entries[i].c_str(), enum_entry_briefs[i].c_str());
fprintf(fp, "`%s` | %s\n", enum_entries[i].c_str(), enum_entry_briefs[i].c_str());
}
fprintf(fp, "\n");
}
Expand Down Expand Up @@ -411,7 +411,7 @@ void parse_enum()
} else if (s->token.begins_with("CF_ENUM(")) {
s->token.replace("CF_ENUM(", "");
s->token.pop(); // Remove ','
s->doc.enum_entries.add(s->token);
s->doc.enum_entries.add(String("CF_") + s->token);
}
}
if (s->doc.enum_entries.count() != s->doc.enum_entry_briefs.count()) {
Expand Down