From ab7c095ffc2e9d6409fd2983b5462bb3d4609e60 Mon Sep 17 00:00:00 2001 From: Carl Worth Date: Sun, 25 Jan 2009 18:18:49 +1100 Subject: [PATCH] Add preliminary implementation of acre This is a simple chart-drawing library using cairo. We will use this to replace the image-magick and perl-using csv2png script, (and then also use this to do interactive charts within a GUI). --- .gitignore | 4 + COPYING | 282 ++++++++++++++++++++++++++++++++++++++++++++++++++++ Makefile | 31 ++++++ README | 4 + acre-test.c | 42 ++++++++ acre.c | 197 ++++++++++++++++++++++++++++++++++++ acre.h | 76 ++++++++++++++ xmalloc.c | 62 ++++++++++++ xmalloc.h | 78 +++++++++++++++ 9 files changed, 776 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 Makefile create mode 100644 acre-test.c create mode 100644 acre.c create mode 100644 acre.h create mode 100644 xmalloc.c create mode 100644 xmalloc.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..60b6ac3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +*.o +Makefile.dep +acre-test +acre-test.png diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..425626f --- /dev/null +++ b/COPYING @@ -0,0 +1,282 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software + interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Program does not specify a +version number of this License, you may choose any version ever +published by the Free Software Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..fcbe7ae --- /dev/null +++ b/Makefile @@ -0,0 +1,31 @@ +bin_PROGRAMS = acre-test + +acre_test_SOURCES = \ + acre-test.c \ + acre.c \ + acre.h \ + xmalloc.c \ + xmalloc.h + +acre_test_LDFLAGS=$$(pkg-config --libs cairo) + +acre_test_CFLAGS=$$(pkg-config --cflags cairo) \ + -Wall -Wextra -Wpointer-arith -Wstrict-prototypes \ + -Wmissing-prototypes -Wmissing-declarations \ + -Wnested-externs -Wno-unused-parameter + +all: $(bin_PROGRAMS) + +acre-test: acre-test.o acre.o xmalloc.o + $(CC) $(LDFLAGS) $(acre_test_LDFLAGS) $(acre_test_CFLAGS) $(CFLAGS) -o $@ $^ + +%.o: %.c + $(CC) $(LDFLAGS) $(acre_test_LDFLAGS) $(acre_test_CFLAGS) $(CFLAGS) -c -o $@ $< + +Makefile.dep: *.c + $(CC) -M $(CPPFLAGS) $(acre_test_CFLAGS) $^ > $@ +-include Makefile.dep + +.PHONY: clean +clean: + rm -f $(bin_PROGRAMS) *.o Makefile.dep diff --git a/README b/README index 80e227a..5512ac6 100644 --- a/README +++ b/README @@ -6,3 +6,7 @@ It's simple to use and generates quite lovely output, but only with a very limited set of features, (currently just line charts with axis ticks, axis labels, a title, and an optional legend). +Acre is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2 of the License, or (at your +option) any later version. See COPYING for more details. diff --git a/acre-test.c b/acre-test.c new file mode 100644 index 0000000..bf1a516 --- /dev/null +++ b/acre-test.c @@ -0,0 +1,42 @@ +#include "acre.h" + +int +main (void) +{ + int i; + + cairo_t *cr; + cairo_surface_t *surface; + + acre_t *acre; + acre_data_t *data; + + surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, 800, 600); + cr = cairo_create (surface); + + acre = acre_create (); + acre_set_title (acre, "Acre Test Plot"); + acre_set_x_axis_label (acre, "X axis"); + acre_set_y_axis_label (acre, "Y axis"); + + data = acre_data_create (); + + acre_data_set_name (data, "Acre test data"); + + for (i = 0; i < 100; i++) + acre_data_add_point_2d (data, i, 100 - (i/4.0)*(i/4.0)); + + acre_add_data (acre, data); + + acre_draw (acre, cr, 800, 600); + + acre_destroy (acre); + + cairo_destroy (cr); + + cairo_surface_write_to_png (surface, "acre-test.png"); + + cairo_surface_destroy (surface); + + return 0; +} diff --git a/acre.c b/acre.c new file mode 100644 index 0000000..672ba62 --- /dev/null +++ b/acre.c @@ -0,0 +1,197 @@ +/* acre - A cairo-based library for creating plots and charts. + * + * Copyright © 2009 Carl Worth + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + */ + +#include "acre.h" +#include "xmalloc.h" + +#include + +typedef struct _acre_data_point_2d { + double x; + double y; +} acre_data_point_2d_t; + +struct _acre_data { + char *name; + + acre_data_point_2d_t *points; + unsigned int points_size; + unsigned int num_points; +}; + +struct _acre { + char *title; + char *x_axis_label; + char *y_axis_label; + + acre_data_t **data; + unsigned int data_size; + unsigned int num_data; +}; + +/* Create a new, empty plot. */ +acre_t * +acre_create (void) +{ + acre_t *acre; + + acre = xmalloc (sizeof (acre_t)); + + acre->title = NULL; + acre->x_axis_label = NULL; + acre->y_axis_label = NULL; + + acre->data = NULL; + acre->data_size = 0; + acre->num_data = 0; + + return acre; +} + +/* Destroy a plot. */ +void +acre_destroy (acre_t *acre) +{ + unsigned int i; + + free (acre->title); + free (acre->x_axis_label); + free (acre->y_axis_label); + + for (i = 0; i < acre->num_data; i++) + acre_data_destroy (acre->data[i]); + + free (acre->data); + + free (acre); +} + +void +acre_set_title (acre_t *acre, const char *title) +{ + free (acre->title); + + acre->title = strdup (title); +} + +void +acre_set_x_axis_label (acre_t *acre, const char *label) +{ + free (acre->x_axis_label); + + acre->x_axis_label = strdup (label); +} + +void +acre_set_y_axis_label (acre_t *acre, const char *label) +{ + free (acre->y_axis_label); + + acre->y_axis_label = strdup (label); +} + +/* Add a dataset to the plot. The plot assumes ownership of the + * dataset so it is not necessary to call acre_data_destroy on it. */ +void +acre_add_data (acre_t *acre, acre_data_t *data) +{ + if (acre->num_data >= acre->data_size) { + acre->data_size *= 2; + if (acre->data_size == 0) + acre->data_size = 1; + acre->data = xrealloc_ab (acre->data, + acre->data_size, + sizeof (acre_data_t *)); + } + + acre->data[acre->num_data] = data; + acre->num_data++; +} + +/* Draw the plot to the given cairo context within a user-space + * rectangle from (0, 0) to (width, height). This size includes all + * space for extra-plot elements (such as the title, the axis labels, + * etc.) + */ +void +acre_draw (acre_t *acre, cairo_t *cr, double width, double height) +{ + cairo_save (cr); + + cairo_rectangle (cr, 0, 0, width, height); + + cairo_set_source_rgb (cr, 1, 0, 1); + + cairo_paint (cr); +} + +/* Create a new dataset---a collection of (x, y) datapoints. A single + * plot can contain multiple datasets, (see acre_add_data). */ +acre_data_t * +acre_data_create (void) +{ + acre_data_t *data; + + data = xmalloc (sizeof (acre_data_t)); + + data->name = NULL; + + data->points = NULL; + data->points_size = 0; + data->num_points = 0; + + return data; +} + +/* Destroy an acre dataset. Do not call this function if the dataset + * has been added to an acre_t plot with acre_add_data. */ +void +acre_data_destroy (acre_data_t *data) +{ + free (data->points); + + free (data); +} + +/* Set the label for this dataset (to appear in the plot's key). */ +void +acre_data_set_name (acre_data_t *data, const char *name) +{ + free (data->name); + + data->name = strdup (name); +} + +/* Add a datapoint to the given dataset. */ +void +acre_data_add_point_2d (acre_data_t *data, double x, double y) +{ + if (data->num_points >= data->points_size) { + data->points_size *= 2; + if (data->points_size == 0) + data->points_size = 16; + data->points = xrealloc_ab (data->points, + data->points_size, + sizeof (acre_data_point_2d_t)); + } + + data->points[data->num_points].x = x; + data->points[data->num_points].y = y; + data->num_points++; +} diff --git a/acre.h b/acre.h new file mode 100644 index 0000000..0a39df9 --- /dev/null +++ b/acre.h @@ -0,0 +1,76 @@ +/* acre - A cairo-based library for creating plots and charts. + * + * Copyright © 2009 Carl Worth + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + */ + +#ifndef ACRE_H +#define ACRE_H + +#include + +typedef struct _acre acre_t; +typedef struct _acre_data acre_data_t; + +/* Create a new, empty plot. */ +acre_t * +acre_create (void); + +/* Destroy a plot. */ +void +acre_destroy (acre_t *acre); + +void +acre_set_title (acre_t *acre, const char *title); + +void +acre_set_x_axis_label (acre_t *acre, const char *label); + +void +acre_set_y_axis_label (acre_t *acre, const char *label); + +/* Add a dataset to the plot. The plot assumes ownership of the + * dataset so it is not necessary to call acre_data_destroy on it. */ +void +acre_add_data (acre_t *acre, acre_data_t *data); + +/* Draw the plot to the given cairo context within a user-space + * rectangle from (0, 0) to (width, height). This size includes all + * space for extra-plot elements (such as the title, the axis labels, + * etc.) + */ +void +acre_draw (acre_t *acre, cairo_t *cr, double width, double height); + +/* Create a new dataset---a collection of (x, y) datapoints. A single + * plot can contain multiple datasets, (see acre_add_data). */ +acre_data_t * +acre_data_create (void); + +/* Destroy an acre dataset. Do not call this function if the dataset + * has been added to an acre_t plot with acre_add_data. */ +void +acre_data_destroy (acre_data_t *data); + +/* Set the label for this dataset (to appear in the plot's key). */ +void +acre_data_set_name (acre_data_t *data, const char *name); + +/* Add a datapoint to the given dataset. */ +void +acre_data_add_point_2d (acre_data_t *data, double x, double y); + +#endif /* ACRE_H */ diff --git a/xmalloc.c b/xmalloc.c new file mode 100644 index 0000000..8c97b0f --- /dev/null +++ b/xmalloc.c @@ -0,0 +1,62 @@ +/* malloc routines with error checking + * + * Copyright © 2007 Mozilla Corporation + * Copyright © 2009 Carl D. Worth + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + * + * Authors: + * Vladimir Vukicevic + * Carl Worth + */ + +#include "xmalloc.h" +#include + +/* Allocate memory using malloc(), checking for errors. + * + * Errors: This function will exit(1) if out-of-memory occurs. + */ +void * +xmalloc (size_t size) +{ + void *ret; + + ret = malloc (size); + if (ret == NULL) { + fprintf (stderr, "Error: out of memory. Exiting.\n"); + exit (1); + } + + return ret; +} + +/* Re-allocate memory using realloc(), checking for errors. + * + * Errors: This function will exit(1) if out-of-memory occurs. + */ +void * +xrealloc (void *ptr, size_t size) +{ + void *ret; + + ret = realloc (ptr, size); + if (ret == NULL) { + fprintf (stderr, "Error: out of memory. Exiting.\n"); + exit (1); + } + + return ret; +} diff --git a/xmalloc.h b/xmalloc.h new file mode 100644 index 0000000..650616a --- /dev/null +++ b/xmalloc.h @@ -0,0 +1,78 @@ +/* malloc routines with error checking + * + * Copyright © 2007 Mozilla Corporation + * Copyright © 2009 Carl D. Worth + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + * + * Authors: + * Vladimir Vukicevic + * Carl Worth + */ + +#ifndef XMALLOC_H +#define XMALLOC_H + +#include +#include + +/* Allocate memory using malloc(), checking for errors. + * + * Errors: This function will exit(1) if out-of-memory occurs. + */ +void * +xmalloc (size_t size); + + +/* Allocates nmemb*size memory using xmalloc(), taking care to not + * overflow when doing the multiplication. + * + * size should be a constant so that the compiler can optimize + * out a constant division. + * + * Return value: A pointer to the newly allocated memory or NULL in + * case of overflow. + * + * Errors: This function will exit(1) if out-of-memory occurs. + */ +#define xmalloc_ab(nmemb, size) \ + ((size) && (unsigned) (nmemb) >= INT32_MAX / (unsigned) (size) ? NULL : \ + xmalloc((unsigned) (nmemb) * (unsigned) (size))) + +/* Re-allocate memory using realloc(), checking for errors. + * + * Errors: This function will exit(1) if out-of-memory occurs. + */ +void * +xrealloc (void *ptr, size_t size); + +/* Reallocates ptr a block of nmemb*@size memory using xrealloc(), taking + * care to not overflow when doing the multiplication. + * + * size should be a constant so that the compiler can optimize + * out a constant division. + * + * Return value: A pointer to the newly allocated memory, or NULL in + * case of overflow (whereupon the original block of memory is left + * untouched). + * + * Errors: This function will exit(1) if out-of-memory occurs. + * + */ +#define xrealloc_ab(ptr, nmemb, size) \ + ((size) && (unsigned) (nmemb) >= INT32_MAX / (unsigned) (size) ? NULL : \ + xrealloc(ptr, (unsigned) (nmemb) * (unsigned) (size))) + +#endif /* XMALLOC_H */ -- 2.43.0