annotate foosdk/sdk/pfc/nix-objects.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 #pragma once
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3 #include <sys/select.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4 #include <sys/time.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 #include <set>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 namespace pfc {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 void nixFormatError( string_base & str, int code );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 class exception_nix : public std::exception {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 exception_nix();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14 exception_nix(int code);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 ~exception_nix() throw() { }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 int code() const throw() {return m_code;}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 const char * what() const throw() {return m_msg.get_ptr();}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21 void _init(int code);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 int m_code;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 string8 m_msg;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 // Toggles non-blocking mode on a file descriptor.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 void setNonBlocking( int fd, bool bNonBlocking = true );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 // Toggles close-on-exec mode on a file descriptor.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 void setCloseOnExec( int fd, bool bCloseOnExec = true );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 // Toggles inheritable mode on a file descriptor. Reverse of close-on-exec.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33 void setInheritable( int fd, bool bInheritable = true );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 // Creates a pipe. The pipe is NOT inheritable by default (close-on-exec set).
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36 void createPipe( int fd[2], bool bInheritable = false );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38 timeval makeTimeVal( double seconds );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39 double importTimeval(const timeval & tv);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41 class fdSet {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44 void operator+=( int fd );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
45 void operator-=( int fd );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
46 bool operator[] (int fd );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47 void clear();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 void operator+=( fdSet const & other );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
51 std::set<int> m_fds;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
52 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55 bool fdCanRead( int fd );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56 bool fdCanWrite( int fd );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58 bool fdWaitRead( int fd, double timeOutSeconds );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59 bool fdWaitWrite( int fd, double timeOutSeconds );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 class fdSelect {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64 int Select();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
65 int Select( double timeOutSeconds );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
66 int Select_( int timeOutMS );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
67
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
68 fdSet Reads, Writes, Errors;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
69 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
70
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
71 void nixSleep(double seconds);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
72 void sleepSeconds(double seconds);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
73 void yield();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
74
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
75 typedef int eventHandle_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
76 static constexpr eventHandle_t eventInvalid = -1;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
77
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
78 class nix_event {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
79 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
80 nix_event(bool state = false);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
81 ~nix_event();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
82
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
83 void set_state( bool state );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
84
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
85 bool is_set( );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
86
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
87 void wait_and_clear() { wait(); set_state(false); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
88 void wait() { wait_for(-1); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
89 bool wait_for( double p_timeout_seconds );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
90
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
91 static bool g_wait_for( int p_event, double p_timeout_seconds );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
92
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
93 eventHandle_t get_handle() const {return m_fd[0]; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
94
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
95 // Two-wait event functions, return 0 on timeout, 1 on evt1 set, 2 on evt2 set
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
96 static int g_twoEventWait( nix_event & ev1, nix_event & ev2, double timeout );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
97 static int g_twoEventWait( int h1, int h2, double timeOut );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
98
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
99 // Multi-wait. Returns SIZE_MAX on timeout, 0 based event index if either event becomes set.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
100 static size_t g_multiWait( const eventHandle_t * events, size_t count, double timeout );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
101 static size_t g_multiWait(std::initializer_list<eventHandle_t> const & arg, double timeout);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
102
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
103 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
104 nix_event(nix_event const&) = delete;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
105 void operator=(nix_event const&) = delete;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
106 int m_fd[2];
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
107 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
108
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
109 typedef nix_event event;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
110
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
111 double nixGetTime();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
112 typedef uint64_t tickcount_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
113 tickcount_t getTickCount();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
114
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
115 bool nixReadSymLink( string_base & strOut, const char * path );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
116 bool nixSelfProcessPath( string_base & strOut );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
117
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
118 void nixGetRandomData( void * outPtr, size_t outBytes );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
119
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
120 bool isShiftKeyPressed();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
121 bool isCtrlKeyPressed();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
122 bool isAltKeyPressed();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
123
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
124 #ifdef __APPLE__
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
125 bool appleRecycleFile( const char * path );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
126 void appleSetThreadDescription( const char * str );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
127 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
128 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
129
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
130 void uSleepSeconds( double seconds, bool );