From 3795a5b60548bdf3eb697522358ae49741add17b Mon Sep 17 00:00:00 2001 From: Bruno Raoult Date: Sun, 29 Aug 2021 13:07:47 +0200 Subject: [PATCH] C: phone-number + new GNUmakefile --- c/phone-number/GNUmakefile | 52 ++++++++++++++++++++ c/phone-number/README.md | 67 ++++++++++++++++++++++++++ c/phone-number/makefile | 37 +++++++++++++++ c/phone-number/src/phone_number.c | 79 +++++++++++++++++++++++++++++++ c/phone-number/src/phone_number.h | 32 +++++++++++++ 5 files changed, 267 insertions(+) create mode 100644 c/phone-number/GNUmakefile create mode 100644 c/phone-number/README.md create mode 100644 c/phone-number/makefile create mode 100644 c/phone-number/src/phone_number.c create mode 100644 c/phone-number/src/phone_number.h diff --git a/c/phone-number/GNUmakefile b/c/phone-number/GNUmakefile new file mode 100644 index 0000000..ea74993 --- /dev/null +++ b/c/phone-number/GNUmakefile @@ -0,0 +1,52 @@ +# The original 'makefile' has a flaw: +# 1) it overrides CFLAGS +# 2) it does not pass extra "FLAGS" to $(CC) that could come from environment +# +# It means : +# - we need to edit 'makefile' for different builds (DEBUG, etc...), which is +# not practical at all. +# - Also, it does not allow to run all tests without editing the test source +# code. +# +# To use this makefile (GNU make only): +# 1) copy it into exercise directory +# 2) add ex.h to exercise include file +# 3) add ex.c to exercise source code, and create a suitable main function +# 4) use make with one of the following targets : +# all: compile and run all predefined tests. +# nowarn: compile with no -Wall and -Wextra, and run all predefined tests +# debug: compile with -DDEBUG and run all predefined tests +# mem: perform memcheck with all tests enabled +# unit: build standalone (unit) bimary +# unitnowarn: build standalone (unit) binary with -Wall and -Wextra disabled +# unitdebug: build standalone binary with -DDEBUG +# +# Original 'makefile' targets can be used (test, memcheck, clean, ...) + +.PHONY: default all nowarn debug mem unit unitnowarn unitdebug standalone + +default: all + +include makefile + +all: CFLAGS+=-DTESTALL +all: clean test + +nowarn: CFLAGS:=$(filter-out -Werror,$(CFLAGS)) +nowarn: clean all + +debug: CFLAGS+=-DDEBUG +debug: all + +mem: CFLAGS+=-DTESTALL +mem: clean memcheck + +unitnowarn: CFLAGS:=$(filter-out -Werror,$(CFLAGS)) +unitnowarn: clean unit + +unitdebug: CFLAGS+=-DDEBUG +unitdebug: clean unit + +unit: CFLAGS+=-DUNIT_TEST +unit: src/*.c src/*.h + $(CC) $(CFLAGS) src/*.c -o tests.out $(LIBS) diff --git a/c/phone-number/README.md b/c/phone-number/README.md new file mode 100644 index 0000000..0a2858b --- /dev/null +++ b/c/phone-number/README.md @@ -0,0 +1,67 @@ +# Phone Number + +Clean up user-entered phone numbers so that they can be sent SMS messages. + +The **North American Numbering Plan (NANP)** is a telephone numbering system used by many countries in North America like the United States, Canada or Bermuda. All NANP-countries share the same international country code: `1`. + +NANP numbers are ten-digit numbers consisting of a three-digit Numbering Plan Area code, commonly known as *area code*, followed by a seven-digit local number. The first three digits of the local number represent the *exchange code*, followed by the unique four-digit number which is the *subscriber number*. + +The format is usually represented as + +```text +(NXX)-NXX-XXXX +``` + +where `N` is any digit from 2 through 9 and `X` is any digit from 0 through 9. + +Your task is to clean up differently formatted telephone numbers by removing punctuation and the country code (1) if present. + +For example, the inputs +- `+1 (613)-995-0253` +- `613-995-0253` +- `1 613 995 0253` +- `613.995.0253` + +should all produce the output + +`6139950253` + +**Note:** As this exercise only deals with telephone numbers used in NANP-countries, only 1 is considered a valid country code. + +## Getting Started + +Make sure you have read the "Guides" section of the +[C track][c-track] on the Exercism site. This covers +the basic information on setting up the development environment expected +by the exercises. + +## Passing the Tests + +Get the first test compiling, linking and passing by following the [three +rules of test-driven development][3-tdd-rules]. + +The included makefile can be used to create and run the tests using the `test` +task. + + make test + +Create just the functions you need to satisfy any compiler errors and get the +test to fail. Then write just enough code to get the test to pass. Once you've +done that, move onto the next test. + +As you progress through the tests, take the time to refactor your +implementation for readability and expressiveness and then go on to the next +test. + +Try to use standard C99 facilities in preference to writing your own +low-level algorithms or facilities by hand. + +## Source + +Event Manager by JumpstartLab [http://tutorials.jumpstartlab.com/projects/eventmanager.html](http://tutorials.jumpstartlab.com/projects/eventmanager.html) + +## Submitting Incomplete Solutions +It's possible to submit an incomplete solution so you can see how others have completed the exercise. + +[c-track]: https://exercism.io/my/tracks/c +[3-tdd-rules]: http://butunclebob.com/ArticleS.UncleBob.TheThreeRulesOfTdd diff --git a/c/phone-number/makefile b/c/phone-number/makefile new file mode 100644 index 0000000..f34535a --- /dev/null +++ b/c/phone-number/makefile @@ -0,0 +1,37 @@ +### If you wish to use extra libraries (math.h for instance), +### add their flags here (-lm in our case) in the "LIBS" variable. + +LIBS = -lm + +### +CFLAGS = -std=c99 +CFLAGS += -g +CFLAGS += -Wall +CFLAGS += -Wextra +CFLAGS += -pedantic +CFLAGS += -Werror +CFLAGS += -Wmissing-declarations +CFLAGS += -DUNITY_SUPPORT_64 + +ASANFLAGS = -fsanitize=address +ASANFLAGS += -fno-common +ASANFLAGS += -fno-omit-frame-pointer + +.PHONY: test +test: tests.out + @./tests.out + +.PHONY: memcheck +memcheck: test/*.c src/*.c src/*.h + @echo Compiling $@ + @$(CC) $(ASANFLAGS) $(CFLAGS) src/*.c test/vendor/unity.c test/*.c -o memcheck.out $(LIBS) + @./memcheck.out + @echo "Memory check passed" + +.PHONY: clean +clean: + rm -rf *.o *.out *.out.dSYM + +tests.out: test/*.c src/*.c src/*.h + @echo Compiling $@ + @$(CC) $(CFLAGS) src/*.c test/vendor/unity.c test/*.c -o tests.out $(LIBS) diff --git a/c/phone-number/src/phone_number.c b/c/phone-number/src/phone_number.c new file mode 100644 index 0000000..6551089 --- /dev/null +++ b/c/phone-number/src/phone_number.c @@ -0,0 +1,79 @@ +#include +#include +#include +#include +#include + +#include "phone_number.h" + +#define LEN_NUM 10 +#define LPAREN '(' + +/* this version is likely not very stable, due to poor scanf() capabilities + * I made it to offer an option to traditional strtok() of manual string + * parsing. + */ +char *phone_number_clean(const char *input) +{ + char *scan="%m[+(0-9]%*[()-. ]%m[0-9]%*[()-. ]%m[0-9]%*[-. ]%m[0-9]"; + char *sn[4]; + int64_t num[4]; + int64_t *p = &num[0]; + int nmatch; + char *res; + + if (!(res = malloc(LEN_NUM+1))) + return NULL; + memset(res, '0', LEN_NUM); + *(res+LEN_NUM) = 0; + + nmatch = sscanf(input, scan, &sn[0], &sn[1], &sn[2], &sn[3]); + + for (int i=0; i 10000000000) + num[0] -= 10000000000; + if (num[0] > 9999999999 || num[0] < 2000000000) + return res; + break; + case 4: /* area */ + if (num[0] != 1) + return res; + p++; + fallthrough; + case 3: /* last 3 numbers */ + if (p[0] < 200 || p[0] > 999 || p[1] < 200 || p[1] > 999 || + p[2] < 0 || p[2] > 9999) + return res; + break; + } + snprintf(res, LEN_NUM+1, "%ld%ld%ld", *p, *(p+1), *(p+2)); + + return res; +} + +/* See GNUmakefile below for explanation + * https://github.com/braoult/exercism/blob/master/c/templates/GNUmakefile + */ +#ifdef UNIT_TEST +int main(int ac, char **av) +{ + int arg; + char *res; + + for (arg=1; arg [%s]\n", res); + free(res); + } +} +#endif diff --git a/c/phone-number/src/phone_number.h b/c/phone-number/src/phone_number.h new file mode 100644 index 0000000..9cae0f5 --- /dev/null +++ b/c/phone-number/src/phone_number.h @@ -0,0 +1,32 @@ +#ifndef PHONE_NUMBER_H +#define PHONE_NUMBER_H + +#define NUMBER_LENGTH 10 + +char *phone_number_clean(const char *input); + +/* from : + * https://github.com/torvalds/linux/blob/master/include/linux/compiler_attributes.h + * around line 200 + * should work with recent gcc/clang + */ +#if __has_attribute(__fallthrough__) +# define fallthrough __attribute__((__fallthrough__)) +#else +# define fallthrough do {} while (0) /* fallthrough */ +#endif + +/* See GNUmakefile below for explanation + * https://github.com/braoult/exercism/blob/master/c/templates/GNUmakefile + */ +#if defined UNIT_TEST || defined DEBUG +#include +#include +#endif + +#ifdef TESTALL +#undef TEST_IGNORE +#define TEST_IGNORE() {} +#endif + +#endif