Standardise string copying to a fixed-size buffer with a portable version of strlcpy

Author: tturocy

src/cwlib/box.c

@@ -29,6 +29,7 @@
 #include <string.h>
 
 #include "chadwick.h"
+#include "util.h"
 
 /*
  * Create an initialize a batting statistic entry
@@ -279,8 +280,7 @@ cw_box_add_substitute(CWBoxscore *boxscore, CWGameIterator *gameiter)
        * Try to do something reasonable here. 
        */
       CWBoxPlayer *player = cw_box_player_create(sub->player_id, sub->name);
-      strncpy(player->date, gameiter->state->date, 8);
-      player->date[8] = '\0';
+      CW_STRLCPY(player->date, gameiter->state->date);
       player->batting->g = 1;
       boxscore->slots[sub->slot][sub->team] = player;
     }
@@ -310,8 +310,7 @@ cw_box_add_substitute(CWBoxscore *boxscore, CWGameIterator *gameiter)
     else if (strcmp(sub->player_id,
                     boxscore->slots[sub->slot][sub->team]->player_id) != 0) {
       CWBoxPlayer *player = cw_box_player_create(sub->player_id, sub->name);
-      strncpy(player->date, gameiter->state->date, 8);
-      player->date[8] = '\0';
+      CW_STRLCPY(player->date, gameiter->state->date);
       player->batting->g = 1;
       boxscore->slots[sub->slot][sub->team]->next = player;
       player->prev = boxscore->slots[sub->slot][sub->team];

src/cwlib/game.c

@@ -867,7 +867,7 @@ cw_game_read(FILE *file)
       batter = cw_strtok(NULL);
       bats = cw_strtok(NULL);
       if (batter && bats) {
-        strncpy(batHandBatter, batter, 255);
+        CW_STRLCPY(batHandBatter, batter);
         batHand = bats[0];
       }
     }
@@ -876,7 +876,7 @@ cw_game_read(FILE *file)
       pitcher = cw_strtok(NULL);
       throws = cw_strtok(NULL);
       if (pitcher && throws) {
-        strncpy(pitHandPitcher, pitcher, 255);
+        CW_STRLCPY(pitHandPitcher, pitcher);
         pitHand = throws[0];
       }
     }
@@ -899,7 +899,7 @@ cw_game_read(FILE *file)
       runner = cw_strtok(NULL);
       base = cw_strtok(NULL);
       if (runner && base) {
-        strncpy(autoRunner, runner, 255);
+        CW_STRLCPY(autoRunner, runner);
         autoBase = cw_atoi(base, NULL);
       }
     }
@@ -911,7 +911,7 @@ cw_game_read(FILE *file)
       if (pitcher && base_str) {
         base = cw_atoi(base_str, NULL);
         if (base >= 1 && base <= 3) {
-          strncpy(presadj[base], pitcher, 255);
+          CW_STRLCPY(presadj[base], pitcher);
         }
         else {
           cw_game_warn_invalid_record(game, line);

src/cwlib/gameiter.c

@@ -51,11 +51,11 @@ cw_gamestate_base_occupied(CWGameState *state, int base)
 static void
 cw_gamestate_place_runner(CWGameState *state, int base, char *runner)
 {
-  strncpy(state->runners[base].runner, runner, 49);
-  strncpy(state->runners[base].pitcher,
-	  state->fielders[1][1-state->batting_team], 49);
-  strncpy(state->runners[base].catcher,
-	  state->fielders[2][1-state->batting_team], 49);
+  CW_STRLCPY(state->runners[base].runner, runner);
+  CW_STRLCPY(state->runners[base].pitcher,
+	         state->fielders[1][1-state->batting_team]);
+  CW_STRLCPY(state->runners[base].catcher,
+	         state->fielders[2][1-state->batting_team]);
   state->runners[base].is_auto = 1;
   state->num_auto_runners[state->batting_team]++;
 }
@@ -67,18 +67,18 @@ cw_gamestate_place_runner(CWGameState *state, int base, char *runner)
 static void
 cw_gamestate_place_batter(CWGameState *state, char *batter, int event_type)
 {
-  strncpy(state->runners[0].runner, batter, 49);
+  CW_STRLCPY(state->runners[0].runner, batter);
   if ((event_type == CW_EVENT_WALK ||
        event_type == CW_EVENT_INTENTIONALWALK) &&
       state->walk_pitcher) {
     strcpy(state->runners[0].pitcher, state->walk_pitcher);
   }
   else {
-    strncpy(state->runners[0].pitcher,
-	    state->fielders[1][1-state->batting_team], 49);
+    CW_STRLCPY(state->runners[0].pitcher,
+	           state->fielders[1][1-state->batting_team]);
   }
-  strncpy(state->runners[0].catcher,
-	  state->fielders[2][1-state->batting_team], 49);
+  CW_STRLCPY(state->runners[0].catcher,
+	         state->fielders[2][1-state->batting_team]);
   state->runners[0].src_event = state->event_count;
   state->runners[0].is_auto = 0;
 }
@@ -90,7 +90,7 @@ cw_gamestate_place_batter(CWGameState *state, char *batter, int event_type)
 static void
 cw_gamestate_replace_runner(CWGameState *state, int base, char *runner)
 {
-  strncpy(state->runners[base].runner, runner, 49);
+  CW_STRLCPY(state->runners[base].runner, runner);
 }
 
 static void
@@ -920,7 +920,7 @@ cw_gameiter_process_comments(CWGameIterator *gameiter)
     if (strstr(comment->text, "suspended,") == comment->text) {
       strtok(comment->text, ",");
       token = strtok(NULL, ",");
-      strncpy(gameiter->state->date, token, 8);
+      CW_STRLCPY(gameiter->state->date, token);
     }
     comment = comment->next;
   }
@@ -982,8 +982,8 @@ cw_gameiter_next(CWGameIterator *gameiter)
   if (gameiter->event) {
     for (base = 1; base <= 3; base++) {
       if (gameiter->event->presadj[base] != NULL) {
-        strncpy(gameiter->state->runners[base].pitcher,
-                gameiter->event->presadj[base], 49);
+        CW_STRLCPY(gameiter->state->runners[base].pitcher,
+                   gameiter->event->presadj[base]);
       }
     }
   }

src/cwlib/parse.c

@@ -26,6 +26,7 @@
 #include <ctype.h>
 
 #include "parse.h"
+#include "util.h"
 
 /**************************************************************************
  * Data access on CWEventData objects
@@ -153,7 +154,7 @@ cw_event_rbi_on_play(CWEventData *event)
 void
 cw_event_set_play(CWEventData *event, int base, char *play)
 {
-  strncpy(event->play[base], play, 20);
+  CW_STRLCPY(event->play[base], play);
 }
 
 /*

src/cwlib/util.h

@@ -36,3 +36,17 @@
     dest = NULL; \
   }
 
+
+/* Utility macro to implement copying to a fixed-size array
+ */
+#define CW_STRLCPY(dst, src) \
+  do { \
+    if ((src) != NULL) { \
+      strncpy((dst), (src), sizeof(dst) - 1); \
+      (dst)[sizeof(dst) - 1] = '\0'; \
+    } \
+    else { \
+      (dst)[0] = '\0'; \
+    } \
+  } while (0)
+