api: Renamed SDLNet_* to NET_*.

This fits better with the other satellite libraries.

Fixes #130.

Author: icculus

.wikiheaders-options

@@ -2,7 +2,7 @@ projectfullname = SDL_net
 projectshortname = SDL_net
 incsubdir = include/SDL3_net
 wikisubdir = SDL3_net
-apiprefixregex = SDLNet_
+apiprefixregex = NET_
 mainincludefname = SDL3_net/SDL_net.h
 versionfname = include/SDL3_net/SDL_net.h
 versionmajorregex = \A\#define\s+SDL_NET_MAJOR_VERSION\s+(\d+)\Z

CMakeLists.txt

@@ -281,7 +281,7 @@ if(SDLNET_INSTALL)
         sdl_get_git_revision_hash(SDLNET_REVISION)
         SDL_generate_manpages(
             HEADERS_DIR "${PROJECT_SOURCE_DIR}/include/SDL3_net"
-            SYMBOL "SDLNet_Init"
+            SYMBOL "NET_Init"
             WIKIHEADERS_PL_PATH "${CMAKE_CURRENT_SOURCE_DIR}/build-scripts/wikiheaders.pl"
             REVISION "${SDLNET_REVISION}"
         )

cmake/test/main.c

@@ -9,11 +9,11 @@ int main(int argc, char *argv[])
         return 1;
     }
 
-    if (!SDLNet_Init()) {
+    if (!NET_Init()) {
         SDL_Log("SDL_Net_Init() failed: %s", SDL_GetError());
     }
 
-    SDLNet_Quit();
+    NET_Quit();
     SDL_Quit();
     return 0;
 }

examples/get-local-addrs.c

@@ -12,32 +12,32 @@
 
 int main(int argc, char **argv)
 {
-    SDLNet_Address **addrs = NULL;
+    NET_Address **addrs = NULL;
     int num_addrs = 0;
     int i;
 
     (void)argc;
     (void)argv;
 
-    if (!SDLNet_Init()) {
-        SDL_Log("SDLNet_Init() failed: %s", SDL_GetError());
+    if (!NET_Init()) {
+        SDL_Log("NET_Init() failed: %s", SDL_GetError());
         return 1;
     }
 
-    addrs = SDLNet_GetLocalAddresses(&num_addrs);
+    addrs = NET_GetLocalAddresses(&num_addrs);
     if (addrs == NULL) {
         SDL_Log("Failed to determine local addresses: %s", SDL_GetError());
-        SDLNet_Quit();
+        NET_Quit();
         return 1;
     }
 
     SDL_Log("We saw %d local addresses:", num_addrs);
     for (i = 0; i < num_addrs; i++) {
-        SDL_Log("  - %s", SDLNet_GetAddressString(addrs[i]));
+        SDL_Log("  - %s", NET_GetAddressString(addrs[i]));
     }
 
-    SDLNet_FreeLocalAddresses(addrs);
-    SDLNet_Quit();
+    NET_FreeLocalAddresses(addrs);
+    NET_Quit();
 
     return 0;
 }

examples/resolve-hostnames.c

@@ -12,31 +12,31 @@
 
 int main(int argc, char **argv)
 {
-    if (!SDLNet_Init()) {
-        SDL_Log("SDLNet_Init() failed: %s", SDL_GetError());
+    if (!NET_Init()) {
+        SDL_Log("NET_Init() failed: %s", SDL_GetError());
         return 1;
     }
 
-    //SDLNet_SimulateAddressResolutionLoss(3000, 30);
+    //NET_SimulateAddressResolutionLoss(3000, 30);
 
-    SDLNet_Address **addrs = (SDLNet_Address **) SDL_calloc(argc, sizeof (SDLNet_Address *));
+    NET_Address **addrs = (NET_Address **) SDL_calloc(argc, sizeof (NET_Address *));
     for (int i = 1; i < argc; i++) {
-        addrs[i] = SDLNet_ResolveHostname(argv[i]);
+        addrs[i] = NET_ResolveHostname(argv[i]);
     }
 
     for (int i = 1; i < argc; i++) {
-        SDLNet_WaitUntilResolved(addrs[i], -1);
+        NET_WaitUntilResolved(addrs[i], -1);
 
-        if (SDLNet_GetAddressStatus(addrs[i]) == -1) {
+        if (NET_GetAddressStatus(addrs[i]) == -1) {
             SDL_Log("%s: [FAILED TO RESOLVE: %s]", argv[i], SDL_GetError());
         } else {
-            SDL_Log("%s: %s", argv[i], SDLNet_GetAddressString(addrs[i]));
+            SDL_Log("%s: %s", argv[i], NET_GetAddressString(addrs[i]));
         }
 
-        SDLNet_UnrefAddress(addrs[i]);
+        NET_UnrefAddress(addrs[i]);
     }
 
-    SDLNet_Quit();
+    NET_Quit();
 
     return 0;
 }

examples/simple-http-get.c

@@ -13,35 +13,35 @@
 
 int main(int argc, char **argv)
 {
-    if (!SDLNet_Init()) {
-        SDL_Log("SDLNet_Init() failed: %s", SDL_GetError());
+    if (!NET_Init()) {
+        SDL_Log("NET_Init() failed: %s", SDL_GetError());
         return 1;
     }
 
     for (int i = 1; i < argc; i++) {
         SDL_Log("Looking up %s ...", argv[i]);
-        SDLNet_Address *addr = SDLNet_ResolveHostname(argv[i]);
-        if (SDLNet_WaitUntilResolved(addr, -1) == -1) {
+        NET_Address *addr = NET_ResolveHostname(argv[i]);
+        if (NET_WaitUntilResolved(addr, -1) == -1) {
             SDL_Log("Failed to lookup %s: %s", argv[i], SDL_GetError());
         } else {
-            SDL_Log("%s is %s", argv[i], SDLNet_GetAddressString(addr));
+            SDL_Log("%s is %s", argv[i], NET_GetAddressString(addr));
             char *req = NULL;
             SDL_asprintf(&req, "GET / HTTP/1.0\r\nHost: %s\r\n\r\n", argv[i]);
-            SDLNet_StreamSocket *sock = req ? SDLNet_CreateClient(addr, 80) : NULL;
+            NET_StreamSocket *sock = req ? NET_CreateClient(addr, 80) : NULL;
             if (!req) {
                 SDL_Log("Out of memory!");
             } else if (!sock) {
                 SDL_Log("Failed to create stream socket to %s: %s\n", argv[i], SDL_GetError());
-            } else if (SDLNet_WaitUntilConnected(sock, -1) < 0) {
+            } else if (NET_WaitUntilConnected(sock, -1) < 0) {
                 SDL_Log("Failed to connect to %s: %s", argv[i], SDL_GetError());
-            } else if (!SDLNet_WriteToStreamSocket(sock, req, SDL_strlen(req))) {
+            } else if (!NET_WriteToStreamSocket(sock, req, SDL_strlen(req))) {
                 SDL_Log("Failed to write to %s: %s", argv[i], SDL_GetError());
-            } else if (SDLNet_WaitUntilStreamSocketDrained(sock, -1) < 0) {
+            } else if (NET_WaitUntilStreamSocketDrained(sock, -1) < 0) {
                 SDL_Log("Failed to finish write to %s: %s", argv[i], SDL_GetError());
             } else {
                 char buf[512];
                 int br;
-                while ((br = SDLNet_ReadFromStreamSocket(sock, buf, sizeof (buf))) >= 0) {
+                while ((br = NET_ReadFromStreamSocket(sock, buf, sizeof (buf))) >= 0) {
                     fwrite(buf, 1, br, stdout);
                 }
 
@@ -50,15 +50,15 @@ int main(int argc, char **argv)
             }
 
             if (sock) {
-                SDLNet_DestroyStreamSocket(sock);
+                NET_DestroyStreamSocket(sock);
             }
 
             SDL_free(req);
         }
     }
 
 
-    SDLNet_Quit();
+    NET_Quit();
 
     return 0;
 }

examples/voipchat.c

@@ -15,7 +15,7 @@
 typedef struct Voice
 {
     SDL_AudioStream *stream;
-    SDLNet_Address *addr;
+    NET_Address *addr;
     Uint16 port;
     Uint64 idnum;
     Uint64 last_seen;
@@ -24,8 +24,8 @@ typedef struct Voice
     struct Voice *next;
 } Voice;
 
-static SDLNet_DatagramSocket *sock = NULL;  /* you talk over this, client or server. */
-static SDLNet_Address *server_addr = NULL;  /* address of the server you're talking to, NULL if you _are_ the server. */
+static NET_DatagramSocket *sock = NULL;  /* you talk over this, client or server. */
+static NET_Address *server_addr = NULL;  /* address of the server you're talking to, NULL if you _are_ the server. */
 static Uint16 server_port = 3025;
 static int max_datagram = 0;
 static Voice *voices = NULL;
@@ -39,11 +39,11 @@ static SDL_AudioStream *capture_stream = NULL;
 static const SDL_AudioSpec audio_spec = { SDL_AUDIO_S16LE, 1, 8000 };
 static Uint64 scratch_area[512];
 
-static Voice *FindVoiceByAddr(const SDLNet_Address *addr, const Uint16 port)
+static Voice *FindVoiceByAddr(const NET_Address *addr, const Uint16 port)
 {
     Voice *i;
     for (i = voices; i != NULL; i = i->next) {
-        if ((i->port == port) && (SDLNet_CompareAddresses(i->addr, addr) == 0)) {
+        if ((i->port == port) && (NET_CompareAddresses(i->addr, addr) == 0)) {
             return i;
         }
     }
@@ -71,7 +71,7 @@ static void ClearOldVoices(const Uint64 now)
             if (!i->stream || (SDL_GetAudioStreamAvailable(i->stream) == 0)) {  /* they'll get a reprieve if data is still playing out */
                 SDL_Log("Destroying voice #%" SDL_PRIu64, i->idnum);
                 SDL_DestroyAudioStream(i->stream);
-                SDLNet_UnrefAddress(i->addr);
+                NET_UnrefAddress(i->addr);
                 if (i->prev) {
                     i->prev->next = next;
                 } else {
@@ -94,8 +94,8 @@ static void SendClientAudioToServer(void)
         next_idnum++;
         scratch_area[0] = SDL_Swap64LE(0);  /* just being nice and leaving space in the buffer for the server to replace. */
         scratch_area[1] = SDL_Swap64LE(next_idnum);
-        SDL_Log("CLIENT: Sending %d new bytes to server at %s:%d...", br + extra, SDLNet_GetAddressString(server_addr), (int) server_port);
-        SDLNet_SendDatagram(sock, server_addr, server_port, scratch_area, br + extra);
+        SDL_Log("CLIENT: Sending %d new bytes to server at %s:%d...", br + extra, NET_GetAddressString(server_addr), (int) server_port);
+        NET_SendDatagram(sock, server_addr, server_port, scratch_area, br + extra);
     }
 }
 
@@ -113,20 +113,20 @@ static void mainloop(void)
         bool activity = false;
         const Uint64 now = SDL_GetTicks();
         SDL_Event event;
-        SDLNet_Datagram *dgram = NULL;
+        NET_Datagram *dgram = NULL;
         int rc;
 
-        while (((rc = SDLNet_ReceiveDatagram(sock, &dgram)) == true) && (dgram != NULL)) {
-            SDL_Log("%s: got %d-byte datagram from %s:%d", is_client ? "CLIENT" : "SERVER", (int) dgram->buflen, SDLNet_GetAddressString(dgram->addr), (int) dgram->port);
+        while (((rc = NET_ReceiveDatagram(sock, &dgram)) == true) && (dgram != NULL)) {
+            SDL_Log("%s: got %d-byte datagram from %s:%d", is_client ? "CLIENT" : "SERVER", (int) dgram->buflen, NET_GetAddressString(dgram->addr), (int) dgram->port);
             activity = true;
             if (!is_client) {  /* we're the server? */
                 Voice *voice = FindVoiceByAddr(dgram->addr, dgram->port);
                 Voice *i;
 
                 if (!voice) {
-                    SDL_Log("SERVER: Creating voice idnum=%" SDL_PRIu64 " from %s:%d", next_idnum + 1, SDLNet_GetAddressString(dgram->addr), (int) dgram->port);
+                    SDL_Log("SERVER: Creating voice idnum=%" SDL_PRIu64 " from %s:%d", next_idnum + 1, NET_GetAddressString(dgram->addr), (int) dgram->port);
                     voice = (Voice *) SDL_calloc(1, sizeof (Voice));
-                    voice->addr = SDLNet_RefAddress(dgram->addr);
+                    voice->addr = NET_RefAddress(dgram->addr);
                     voice->port = dgram->port;
                     voice->idnum = ++next_idnum;
                     if (voices) {
@@ -142,15 +142,15 @@ static void mainloop(void)
                 if (dgram->buflen > extra) {  /* ignore it if too small, might just be a keepalive packet. */
                     *((Uint64 *) dgram->buf) = SDL_Swap64LE(voice->idnum);  /* the client leaves space to fill this in for convenience. */
                     for (i = voices; i != NULL; i = i->next) {
-                        if ((voice->port != i->port) || (SDLNet_CompareAddresses(voice->addr, i->addr) != 0)) {  /* don't send client's own voice back to them. */
-                            SDL_Log("SERVER: sending %d-byte datagram to %s:%d", (int) dgram->buflen, SDLNet_GetAddressString(i->addr), (int) i->port);
-                            SDLNet_SendDatagram(sock, i->addr, i->port, dgram->buf, dgram->buflen);
+                        if ((voice->port != i->port) || (NET_CompareAddresses(voice->addr, i->addr) != 0)) {  /* don't send client's own voice back to them. */
+                            SDL_Log("SERVER: sending %d-byte datagram to %s:%d", (int) dgram->buflen, NET_GetAddressString(i->addr), (int) i->port);
+                            NET_SendDatagram(sock, i->addr, i->port, dgram->buf, dgram->buflen);
                         }
                     }
                 }
             } else {  /* we're the client. */
-                if ((dgram->port != server_port) || (SDLNet_CompareAddresses(dgram->addr, server_addr) != 0)) {
-                    SDL_Log("CLIENT: Got packet from non-server address %s:%d. Ignoring.", SDLNet_GetAddressString(dgram->addr), (int) dgram->port);
+                if ((dgram->port != server_port) || (NET_CompareAddresses(dgram->addr, server_addr) != 0)) {
+                    SDL_Log("CLIENT: Got packet from non-server address %s:%d. Ignoring.", NET_GetAddressString(dgram->addr), (int) dgram->port);
                 } else if (dgram->buflen < extra) {
                     SDL_Log("CLIENT: Got bogus packet from the server. Ignoring.");
                 } else {
@@ -184,7 +184,7 @@ static void mainloop(void)
                 }
             }
 
-            SDLNet_DestroyDatagram(dgram);
+            NET_DestroyDatagram(dgram);
         }
 
         while (SDL_PollEvent(&event)) {
@@ -229,8 +229,8 @@ static void mainloop(void)
                 next_idnum++;
                 scratch_area[0] = SDL_Swap64LE(0);
                 scratch_area[1] = SDL_Swap64LE(next_idnum);
-                SDL_Log("CLIENT: Sending %d keepalive bytes to server at %s:%d...", extra, SDLNet_GetAddressString(server_addr), (int) server_port);
-                SDLNet_SendDatagram(sock, server_addr, server_port, scratch_area, extra);
+                SDL_Log("CLIENT: Sending %d keepalive bytes to server at %s:%d...", extra, NET_GetAddressString(server_addr), (int) server_port);
+                NET_SendDatagram(sock, server_addr, server_port, scratch_area, extra);
                 last_send_ticks = now;
             }
         }
@@ -283,10 +283,10 @@ static void run_voipchat(int argc, char **argv)
         SDL_Log("SERVER: Listening on port %d", server_port);
     } else {
         SDL_Log("CLIENT: Resolving server hostname '%s' ...", hostname);
-        server_addr = SDLNet_ResolveHostname(hostname);
+        server_addr = NET_ResolveHostname(hostname);
         if (server_addr) {
-            if (SDLNet_WaitUntilResolved(server_addr, -1) < 0) {
-                SDLNet_UnrefAddress(server_addr);
+            if (NET_WaitUntilResolved(server_addr, -1) < 0) {
+                NET_UnrefAddress(server_addr);
                 server_addr = NULL;
             }
         }
@@ -297,7 +297,7 @@ static void run_voipchat(int argc, char **argv)
             return;
         }
 
-        SDL_Log("CLIENT: Server is at %s:%d.", SDLNet_GetAddressString(server_addr), (int) server_port);
+        SDL_Log("CLIENT: Server is at %s:%d.", NET_GetAddressString(server_addr), (int) server_port);
 
         audio_device = SDL_OpenAudioDevice(SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK, &audio_spec);
         if (!audio_device) {
@@ -318,12 +318,12 @@ static void run_voipchat(int argc, char **argv)
     }
 
     /* server _must_ be on the requested port. Clients can take anything available, server will respond to where it sees it come from. */
-    sock = SDLNet_CreateDatagramSocket(NULL, is_server ? server_port : 0);
+    sock = NET_CreateDatagramSocket(NULL, is_server ? server_port : 0);
     if (!sock) {
         SDL_Log("Failed to create datagram socket: %s", SDL_GetError());
     } else {
         if (simulate_failure) {
-            SDLNet_SimulateDatagramPacketLoss(sock, simulate_failure);
+            NET_SimulateDatagramPacketLoss(sock, simulate_failure);
         }
         mainloop();
     }
@@ -337,9 +337,9 @@ static void run_voipchat(int argc, char **argv)
     SDL_CloseAudioDevice(capture_device);
     audio_device = capture_device = 0;
 
-    SDLNet_UnrefAddress(server_addr);
+    NET_UnrefAddress(server_addr);
     server_addr = NULL;
-    SDLNet_DestroyDatagramSocket(sock);
+    NET_DestroyDatagramSocket(sock);
     sock = NULL;
 }
 
@@ -351,8 +351,8 @@ int main(int argc, char **argv)
         return 1;
     }
 
-    if (!SDLNet_Init()) {
-        SDL_Log("SDLNet_Init failed: %s\n", SDL_GetError());
+    if (!NET_Init()) {
+        SDL_Log("NET_Init failed: %s\n", SDL_GetError());
         SDL_Quit();
         return 1;
     }
@@ -368,7 +368,7 @@ int main(int argc, char **argv)
     SDL_DestroyRenderer(renderer);
     SDL_DestroyWindow(window);
 
-    SDLNet_Quit();
+    NET_Quit();
     SDL_Quit();
     return 0;
 }