hmn
/
orca
5
Fork 2
Code Issues 21 Pull Requests 1 Packages Projects Releases Wiki Activity
orca/src/platform/platform_path.h

34 lines
1.1 KiB
C
Raw Normal View History

[path] adding platform path functions
2023-05-24 14:27:39 +00:00
/************************************************************//**
*
* @file: platform_path.h
* @author: Martin Fouilleul
* @date: 24/05/2023
*
*****************************************************************/
#ifndef __PLATFORM_PATH_H_
#define __PLATFORM_PATH_H_
#include"util/strings.h"
String functions that return str8/16/32 allocated on an arena implicitly zero-terminate strings, so we can avoid one copy when passing to C stdlib APIs
2023-06-26 14:06:26 +00:00
/*NOTE:
by convention, functions that take an arena and return a path
allocated on that arena allocate 1 more character and null-terminate
the string.
*/
Big renaming and consistency pass, including: - "Namespacing" the Orca APIs by adding the oc_ prefix everywhere - Naming consistency tweaks, eg create_from_memory vs. create_from_data - Adhering to a more consistent convention when pairing functions defining entities lifetime, eg. create/destroy, push/clear, alloc/recycle, init/cleanup - Preferring oc_str8 to const char*, except when we expect lots of C string literals (e.g. when tagging UI widgets) or when it would be annoying to systematically wrap data we want to read/write into a string - Reorganize macros for asserts/logging, and properly exposing them to the apps with non conflicting names - Generally rearrange some bits and pruning unused stuff to make things more navigable
2023-08-14 08:26:11 +00:00
ORCA_API oc_str8 oc_path_slice_directory(oc_str8 path);
ORCA_API oc_str8 oc_path_slice_filename(oc_str8 path);
[path] adding platform path functions
2023-05-24 14:27:39 +00:00
Big renaming and consistency pass, including: - "Namespacing" the Orca APIs by adding the oc_ prefix everywhere - Naming consistency tweaks, eg create_from_memory vs. create_from_data - Adhering to a more consistent convention when pairing functions defining entities lifetime, eg. create/destroy, push/clear, alloc/recycle, init/cleanup - Preferring oc_str8 to const char*, except when we expect lots of C string literals (e.g. when tagging UI widgets) or when it would be annoying to systematically wrap data we want to read/write into a string - Reorganize macros for asserts/logging, and properly exposing them to the apps with non conflicting names - Generally rearrange some bits and pruning unused stuff to make things more navigable
2023-08-14 08:26:11 +00:00
ORCA_API oc_str8_list oc_path_split(oc_arena* arena, oc_str8 path);
ORCA_API oc_str8 oc_path_join(oc_arena* arena, oc_str8_list elements);
ORCA_API oc_str8 oc_path_append(oc_arena* arena, oc_str8 parent, oc_str8 relPath);
[path] adding platform path functions
2023-05-24 14:27:39 +00:00
Big renaming and consistency pass, including: - "Namespacing" the Orca APIs by adding the oc_ prefix everywhere - Naming consistency tweaks, eg create_from_memory vs. create_from_data - Adhering to a more consistent convention when pairing functions defining entities lifetime, eg. create/destroy, push/clear, alloc/recycle, init/cleanup - Preferring oc_str8 to const char*, except when we expect lots of C string literals (e.g. when tagging UI widgets) or when it would be annoying to systematically wrap data we want to read/write into a string - Reorganize macros for asserts/logging, and properly exposing them to the apps with non conflicting names - Generally rearrange some bits and pruning unused stuff to make things more navigable
2023-08-14 08:26:11 +00:00
ORCA_API bool oc_path_is_absolute(oc_str8 path);
ORCA_API oc_str8 oc_path_executable(oc_arena* arena);
ORCA_API oc_str8 oc_path_canonical(oc_arena* arena, oc_str8 path);
[io] abstract file io API, using a request/completion model ala io_uring (w/ only synchronous completion for now), and per-platform backend
2023-05-25 18:08:38 +00:00
Big renaming and consistency pass, including: - "Namespacing" the Orca APIs by adding the oc_ prefix everywhere - Naming consistency tweaks, eg create_from_memory vs. create_from_data - Adhering to a more consistent convention when pairing functions defining entities lifetime, eg. create/destroy, push/clear, alloc/recycle, init/cleanup - Preferring oc_str8 to const char*, except when we expect lots of C string literals (e.g. when tagging UI widgets) or when it would be annoying to systematically wrap data we want to read/write into a string - Reorganize macros for asserts/logging, and properly exposing them to the apps with non conflicting names - Generally rearrange some bits and pruning unused stuff to make things more navigable
2023-08-14 08:26:11 +00:00
// helper: gets the path from oc_path_executable() and appends relPath
ORCA_API oc_str8 oc_path_executable_relative(oc_arena* arena, oc_str8 relPath);
[path] adding platform path functions
2023-05-24 14:27:39 +00:00
#endif //__PLATFORM_PATH_H_