]> git.imager.perl.org - imager.git/blobdiff - limits.c
sacrifice a chicken to the spell-checker gods
[imager.git] / limits.c
index 0d4c22a20c3967cb783dfa3ac68d1df9834439a6..36ae45b5c9afcbe6b3ca98c8ea3b7afa81ffb2ff 100644 (file)
--- a/limits.c
+++ b/limits.c
@@ -21,15 +21,20 @@ limits.c - manages data/functions for limiting the sizes of images read from fil
 Manage limits for image files read by Imager.
 
 Setting a value of zero means that limit will be ignored.
-  
+
+=over
+
+=cut
  */
 
+#define IMAGER_NO_CONTEXT
 #include "imageri.h"
 
 /*
-=item i_set_image_file_limits(width, height, bytes)
-
+=item im_set_image_file_limits(ctx, width, height, bytes)
+X<im_set_image_file_limits API>X<i_set_image_file_limits API>
 =category Files
+=synopsis im_set_image_file_limits(aIMCTX, 500, 500, 1000000);
 =synopsis i_set_image_file_limits(500, 500, 1000000);
 
 Set limits on the sizes of images read by Imager.
@@ -55,11 +60,13 @@ this limit to one gigabyte.
 
 Returns non-zero on success.
 
+Also callable as C<i_set_image_file_limits(width, height, bytes)>.
+
 =cut
 */
 
 int
-im_set_image_file_limits(im_context_t ctx, i_img_dim width, i_img_dim height, size_t bytes) {
+im_set_image_file_limits(pIMCTX, i_img_dim width, i_img_dim height, size_t bytes) {
   i_clear_error();
 
   if (width < 0) {
@@ -75,17 +82,18 @@ im_set_image_file_limits(im_context_t ctx, i_img_dim width, i_img_dim height, si
     return 0;
   }
 
-  ctx->max_width = width;
-  ctx->max_height = height;
-  ctx->max_bytes = bytes ? bytes : DEF_BYTES_LIMIT;
+  aIMCTX->max_width = width;
+  aIMCTX->max_height = height;
+  aIMCTX->max_bytes = bytes ? bytes : DEF_BYTES_LIMIT;
 
   return 1;
 }
 
 /*
-=item i_get_image_file_limits(&width, &height, &bytes)
-
+=item im_get_image_file_limits(ctx, &width, &height, &bytes)
+X<im_get_image_file_limits API>X<i_get_image_file_limits>
 =category Files
+=synopsis im_get_image_file_limits(aIMCTX, &width, &height, &bytes)
 =synopsis i_get_image_file_limits(&width, &height, &bytes)
 
 Retrieves the file limits set by i_set_image_file_limits().
@@ -102,25 +110,28 @@ size_t *bytes - size in memory of the image in bytes.
 
 =back
 
+Also callable as C<i_get_image_file_limits(&width, &height, &bytes)>.
+
 =cut
 */
 
 int
-im_get_image_file_limits(im_context_t ctx, i_img_dim *width, i_img_dim *height, size_t *bytes) {
-  im_clear_error(ctx);
+im_get_image_file_limits(pIMCTX, i_img_dim *width, i_img_dim *height, size_t *bytes) {
+  im_clear_error(aIMCTX);
 
-  *width = ctx->max_width;
-  *height = ctx->max_height;
-  *bytes = ctx->max_bytes;
+  *width = aIMCTX->max_width;
+  *height = aIMCTX->max_height;
+  *bytes = aIMCTX->max_bytes;
 
   return 1;
 }
 
 /*
-=item i_int_check_image_file_limits(width, height, channels, sample_size)
-
+=item im_int_check_image_file_limits(width, height, channels, sample_size)
+X<im_int_check_image_file_limits API>X<i_int_check_image_file_limits>
 =category Files
-=synopsis i_i_int_check_image_file_limits(width, height, channels, sizeof(i_sample_t))
+=synopsis im_int_check_image_file_limits(aIMCTX, width, height, channels, sizeof(i_sample_t))
+=synopsis i_int_check_image_file_limits(width, height, channels, sizeof(i_sample_t))
 
 Checks the size of a file in memory against the configured image file
 limits.
@@ -132,45 +143,47 @@ Returns non-zero if the file is within limits.
 
 This function is intended to be called by image file read functions.
 
+Also callable as C<i_int_check_image_file_limits(width, height, channels, sizeof(i_sample_t)>.
+
 =cut
 */
 
 int
-im_int_check_image_file_limits(im_context_t ctx, i_img_dim width, i_img_dim height, int channels, size_t sample_size) {
+im_int_check_image_file_limits(pIMCTX, i_img_dim width, i_img_dim height, int channels, size_t sample_size) {
   size_t bytes;
-  im_clear_error(ctx);
+  im_clear_error(aIMCTX);
   
   if (width <= 0) {
-    im_push_errorf(ctx, 0, "file size limit - image width of %" i_DF " is not positive",
+    im_push_errorf(aIMCTX, 0, "file size limit - image width of %" i_DF " is not positive",
                  i_DFc(width));
     return 0;
   }
-  if (ctx->max_width && width > ctx->max_width) {
-    im_push_errorf(ctx, 0, "file size limit - image width of %" i_DF " exceeds limit of %" i_DF,
-                 i_DFc(width), i_DFc(ctx->max_width));
+  if (aIMCTX->max_width && width > aIMCTX->max_width) {
+    im_push_errorf(aIMCTX, 0, "file size limit - image width of %" i_DF " exceeds limit of %" i_DF,
+                 i_DFc(width), i_DFc(aIMCTX->max_width));
     return 0;
   }
 
   if (height <= 0) {
-    im_push_errorf(ctx, 0, "file size limit - image height of %" i_DF " is not positive",
+    im_push_errorf(aIMCTX, 0, "file size limit - image height of %" i_DF " is not positive",
                  i_DFc(height));
     return 0;
   }
 
-  if (ctx->max_height && height > ctx->max_height) {
-    im_push_errorf(ctx, 0, "file size limit - image height of %" i_DF
-                 " exceeds limit of %" i_DF, i_DFc(height), i_DFc(ctx->max_height));
+  if (aIMCTX->max_height && height > aIMCTX->max_height) {
+    im_push_errorf(aIMCTX, 0, "file size limit - image height of %" i_DF
+                 " exceeds limit of %" i_DF, i_DFc(height), i_DFc(aIMCTX->max_height));
     return 0;
   }
 
   if (channels < 1 || channels > MAXCHANNELS) {
-    im_push_errorf(ctx, 0, "file size limit - channels %d out of range",
+    im_push_errorf(aIMCTX, 0, "file size limit - channels %d out of range",
                  channels);
     return 0;
   }
   
   if (sample_size < 1 || sample_size > sizeof(long double)) {
-    im_push_errorf(ctx, 0, "file size limit - sample_size %ld out of range",
+    im_push_errorf(aIMCTX, 0, "file size limit - sample_size %ld out of range",
                  (long)sample_size);
     return 0;
   }
@@ -182,14 +195,14 @@ im_int_check_image_file_limits(im_context_t ctx, i_img_dim width, i_img_dim heig
   bytes = width * height * channels * sample_size;
   if (bytes / width != height * channels * sample_size
       || bytes / height != width * channels * sample_size) {
-    i_push_error(0, "file size limit - integer overflow calculating storage");
+    im_push_error(aIMCTX, 0, "file size limit - integer overflow calculating storage");
     return 0;
   }
-  if (ctx->max_bytes) {
-    if (bytes > ctx->max_bytes) {
-      im_push_errorf(ctx, 0, "file size limit - storage size of %lu "
+  if (aIMCTX->max_bytes) {
+    if (bytes > aIMCTX->max_bytes) {
+      im_push_errorf(aIMCTX, 0, "file size limit - storage size of %lu "
                    "exceeds limit of %lu", (unsigned long)bytes,
-                   (unsigned long)ctx->max_bytes);
+                   (unsigned long)aIMCTX->max_bytes);
       return 0;
     }
   }