ruby-iup 0.0.2 → 0.1.0

data/ext/extconf.rb

@@ -1,27 +1,62 @@
-# extconf.rb for ruby-iup extension module.
-#
-# Copyright (C) 2008 Park Heesob <jmg3000@gmail.com>
-#
-# This program is distributed under the terms of the MIT license.
-# See the included COPYRIGHT file for the terms of this license.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require 'ftools'
-
-if RUBY_PLATFORM =~ /win32/
-	ldir = "./iup-win32"
-    Dir[ldir+"/*.dll"].each do |f|
-        File.install(f,Config::CONFIG['bindir'],0644,true)
-    end
-end
-File.open("nmake.bat","w")
-File.open("Makefile","w") {|f|
-  f.puts("install:")
-}
+# extconf.rb for ruby-iup extension module.
+#
+# Copyright (C) 2008 Park Heesob <phasis@gmail.com>
+#
+# This program is distributed under the terms of the MIT license.
+# See the included COPYRIGHT file for the terms of this license.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+require 'mkmf' 
+
+if RUBY_PLATFORM =~ /mingw32/
+  dir_config('iup','./iup-mingw32/include','./iup-mingw32')
+elsif RUBY_PLATFORM =~ /mswin32/
+  dir_config('iup','./iup-mswin32/include','./iup-mswin32')
+else
+  dir_config('iup','./iup-linux/include','./iup-linux')
+  have_library('GL')
+end
+
+have_library('freetype6')
+have_library('freetype')
+have_library('stdc++')
+have_library('gdi32')
+have_library('comctl32')
+have_library('comdlg32')
+have_library('opengl32')
+have_library('ole32')
+have_library('oleaut32')
+have_library('uuid')
+have_library('iup')
+have_library('pdflib')
+have_library('cdgdk')
+have_library('cdpdf')
+have_library('cdcontextplus')
+have_library('cd')
+have_library('im')
+have_library('im_avi')
+have_library('im_fftw')
+have_library('im_jp2')
+have_library('im_process')
+have_library('iup_pplot')
+have_library('iupcd')
+have_library('iupole')
+have_library('iupcontrols')
+have_library('iupgl')
+have_library('iupim')
+have_library('iupimglib')
+
+
+if RUBY_PLATFORM =~ /mswin32/
+  $LOCAL_LIBS = "-link /nodefaultlib:msvcrt.lib"
+elsif RUBY_PLATFORM =~ /linux/
+  $LOCAL_LIBS = `pkg-config --libs gtk+-2.0`
+end
+
+create_makefile('iup')

data/ext/iup-linux/include/cd.h

@@ -18,10 +18,10 @@ extern "C" {
 
 #define CD_NAME "CD - Canvas Draw"
 #define CD_DESCRIPTION "A 2D Graphics Library"
-#define CD_COPYRIGHT    "Copyright (C) 1994-2008 Tecgraf, PUC-Rio."
-#define CD_VERSION "5.1"
-#define CD_VERSION_DATE "2008/10/14"
-#define CD_VERSION_NUMBER 501000
+#define CD_COPYRIGHT    "Copyright (C) 1994-2010 Tecgraf, PUC-Rio."
+#define CD_VERSION "5.3"              /* bug fixes are reported only by cdVersion functions */
+#define CD_VERSION_NUMBER 503000
+#define CD_VERSION_DATE "2010/01/26"
 
 typedef struct _cdContext cdContext;
 typedef struct _cdCanvas cdCanvas;
@@ -76,6 +76,7 @@ int  cdCanvasPlay(cdCanvas* canvas, cdContext *context, int xmin, int xmax, int
 void cdCanvasGetSize(cdCanvas* canvas, int *width, int *height, double *width_mm, double *height_mm);
 int cdCanvasUpdateYAxis(cdCanvas* canvas, int* y);
 double cdfCanvasUpdateYAxis(cdCanvas* canvas, double* y);
+int cdCanvasYAxisMode(cdCanvas* canvas, int invert);
 int cdCanvasInvertYAxis(cdCanvas* canvas, int y);
 double cdfCanvasInvertYAxis(cdCanvas* canvas, double y);
 void cdCanvasMM2Pixel(cdCanvas* canvas, double mm_dx, double mm_dy, int *dx, int *dy);
@@ -169,10 +170,13 @@ void cdCanvasVectorTextDirection(cdCanvas* canvas, int x1, int y1, int x2, int y
 double* cdCanvasVectorTextTransform(cdCanvas* canvas, const double* matrix);
 void cdCanvasVectorTextSize(cdCanvas* canvas, int size_x, int size_y, const char* s);
 int  cdCanvasVectorCharSize(cdCanvas* canvas, int size);
+void cdCanvasVectorFontSize(cdCanvas* canvas, double size_x, double size_y);
+void cdCanvasGetVectorFontSize(cdCanvas* canvas, double *size_x, double *size_y);
 
 /* vector text properties */
 void cdCanvasGetVectorTextSize(cdCanvas* canvas, const char* s, int *x, int *y);
 void cdCanvasGetVectorTextBounds(cdCanvas* canvas, const char* s, int x, int y, int *rect);
+void cdCanvasGetVectorTextBox(cdCanvas* canvas, int x, int y, const char *s, int *xmin, int *xmax, int *ymin, int *ymax);
 
 /* properties */
 void cdCanvasGetFontDim(cdCanvas* canvas, int *max_width, int *height, int *ascent, int *descent);
@@ -468,7 +472,7 @@ typedef int(*cdSizeCB)(cdCanvas *canvas, int w, int h, double w_mm, double h_mm)
 
 
 /******************************************************************************
-Copyright (C) 1994-2008 Tecgraf, PUC-Rio.
+Copyright (C) 1994-2010 Tecgraf, PUC-Rio.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/ext/iup-linux/include/cd_private.h

@@ -92,7 +92,7 @@ struct _cdCanvas
   void   (*cxArc)(cdCtxCanvas* ctxcanvas, int xc, int yc, int w, int h, double angle1, double angle2);
   void   (*cxSector)(cdCtxCanvas* ctxcanvas, int xc, int yc, int w, int h, double angle1, double angle2);
   void   (*cxChord)(cdCtxCanvas* ctxcanvas, int xc, int yc, int w, int h, double angle1, double angle2);
-  void   (*cxText)(cdCtxCanvas* ctxcanvas, int x, int y, const char *s);
+  void   (*cxText)(cdCtxCanvas* ctxcanvas, int x, int y, const char *s, int len);
   void   (*cxKillCanvas)(cdCtxCanvas* ctxcanvas);
   int    (*cxFont)(cdCtxCanvas* ctxcanvas, const char *type_face, int style, int size);
   void   (*cxPutImageRectMap)(cdCtxCanvas* ctxcanvas, int iw, int ih, const unsigned char *index, const long *colors, int x, int y, int w, int h, int xmin, int xmax, int ymin, int ymax);
@@ -100,7 +100,7 @@ struct _cdCanvas
 
   /* default implementation uses the simulation driver */
   void   (*cxGetFontDim)(cdCtxCanvas* ctxcanvas, int *max_width, int *height, int *ascent, int *descent);
-  void   (*cxGetTextSize)(cdCtxCanvas* ctxcanvas, const char *s, int *width, int *height);
+  void   (*cxGetTextSize)(cdCtxCanvas* ctxcanvas, const char *s, int len, int *width, int *height);
 
   /* all the following function pointers can be NULL */
 
@@ -114,7 +114,7 @@ struct _cdCanvas
   void   (*cxFArc)(cdCtxCanvas* ctxcanvas, double xc, double yc, double w, double h, double angle1, double angle2);
   void   (*cxFSector)(cdCtxCanvas* ctxcanvas, double xc, double yc, double w, double h, double angle1, double angle2);
   void   (*cxFChord)(cdCtxCanvas* ctxcanvas, double xc, double yc, double w, double h, double angle1, double angle2);
-  void   (*cxFText)(cdCtxCanvas* ctxcanvas, double x, double y, const char *s);
+  void   (*cxFText)(cdCtxCanvas* ctxcanvas, double x, double y, const char *s, int len);
 
   int    (*cxClip)(cdCtxCanvas* ctxcanvas, int mode);
   void   (*cxClipArea)(cdCtxCanvas* ctxcanvas, int xmin, int xmax, int ymin, int ymax);
@@ -233,6 +233,8 @@ struct _cdCanvas
   cdContext* context;
 };
 
+enum{CD_BASE_WIN, CD_BASE_X, CD_BASE_GDK};
+int cdBaseDriver(void);
 
 /***************/
 /* attributes  */
@@ -268,6 +270,9 @@ int cdfCheckBoxSize(double *xmin, double *xmax, double *ymin, double *ymax);
 void cdNormalizeLimits(int w, int h, int *xmin, int *xmax, int *ymin, int *ymax);
 int cdGetFileName(const char* strdata, char* filename);
 int cdStrEqualNoCase(const char* str1, const char* str2);
+int cdStrLineCount(const char* str);
+char* cdStrDup(const char* str);
+char* cdStrDupN(const char* str, int len);
 
 #define _cdCheckCanvas(_canvas) (_canvas!=NULL && ((unsigned char*)_canvas)[0] == 'C' && ((unsigned char*)_canvas)[1] == 'D')
 #define _cdInvertYAxis(_canvas, _y) (_canvas->h - (_y) - 1)
@@ -286,6 +291,8 @@ void cdMatrixInverse(const double* matrix, double* inv_matrix);
 void cdRotatePoint(cdCanvas* canvas, int x, int y, int cx, int cy, int *rx, int *ry, double sin_teta, double cos_teta);
 void cdRotatePointY(cdCanvas* canvas, int x, int y, int cx, int cy, int *ry, double sin_theta, double cos_theta);
 void cdTextTranslatePoint(cdCanvas* canvas, int x, int y, int w, int h, int baseline, int *rx, int *ry);
+void cdMovePoint(int *x, int *y, double dx, double dy, double sin_theta, double cos_theta);
+void cdfMovePoint(double *x, double *y, double dx, double dy, double sin_theta, double cos_theta);
 
 /*************/
 /*   Fonts   */
@@ -331,10 +338,10 @@ void cdchordSIM(cdCtxCanvas* ctxcanvas, int xc, int yc, int width, int height, d
 void cdpolySIM(cdCtxCanvas* ctxcanvas, int mode, cdPoint* points, int n);
 
 /* Replacements for Text and Font using FreeType library */
-void cdtextSIM(cdCtxCanvas* ctxcanvas, int x, int y, const char *s);
+void cdtextSIM(cdCtxCanvas* ctxcanvas, int x, int y, const char *s, int len);
 int cdfontSIM(cdCtxCanvas* ctxcanvas, const char *type_face, int style, int size);
 void cdgetfontdimSIM(cdCtxCanvas* ctxcanvas, int *max_width, int *height, int *ascent, int *descent);
-void cdgettextsizeSIM(cdCtxCanvas* ctxcanvas, const char *s, int *width, int *height);
+void cdgettextsizeSIM(cdCtxCanvas* ctxcanvas, const char *s, int len, int *width, int *height);
 
 /* Simulation functions that are independent of the simulation base driver */
 void cdSimMark(cdCanvas* canvas, int x, int y);
@@ -352,7 +359,7 @@ void cdfSimArc(cdCtxCanvas *ctxcanvas, double xc, double yc, double width, doubl
 
 /* Replacements for Font using estimation */
 void cdgetfontdimEX(cdCtxCanvas* ctxcanvas, int *max_width, int *height, int *ascent, int *descent);
-void cdgettextsizeEX(cdCtxCanvas* ctxcanvas, const char *s, int *width, int *height);
+void cdgettextsizeEX(cdCtxCanvas* ctxcanvas, const char *s, int len, int *width, int *height);
 
 
 #ifdef __cplusplus

data/ext/iup-linux/include/cdsvg.h

@@ -0,0 +1,22 @@
+/** \file
+ * \brief SVG driver
+ *
+ * See Copyright Notice in cd.h
+ */
+
+#ifndef __CD_SVG_H
+#define __CD_SVG_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+cdContext* cdContextSVG(void);
+
+#define CD_SVG cdContextSVG()
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* ifndef __CD_SVG_ */

data/ext/iup-linux/include/im.h

@@ -1,282 +1,287 @@
-/** \file
- * \brief Main API
- *
- * See Copyright Notice in im_lib.h
- */
-
-#ifndef __IM_H
-#define __IM_H
-
-#if	defined(__cplusplus)
-extern "C" {
-#endif
-      
-
-/** Image data type descriptors. \n
- * See also \ref datatypeutl.
- * \ingroup imagerep */
-enum imDataType
-{
-  IM_BYTE,   /**< "unsigned char". 1 byte from 0 to 255.                  */
-  IM_USHORT, /**< "unsigned short". 2 bytes from 0 to 65,535.             */
-  IM_INT,    /**< "int". 4 bytes from -2,147,483,648 to 2,147,483,647.    */
-  IM_FLOAT,  /**< "float". 4 bytes single precision IEEE floating point.  */
-  IM_CFLOAT  /**< complex "float". 2 float values in sequence, real and imaginary parts.   */
-};
-
-/** Image color mode color space descriptors (first byte). \n
- * See also \ref colormodeutl.
- * \ingroup imagerep */
-enum imColorSpace
-{
-  IM_RGB,    /**< Red, Green and Blue (nonlinear).              */
-  IM_MAP,    /**< Indexed by RGB color map (data_type=IM_BYTE). */
-  IM_GRAY,   /**< Shades of gray, luma (nonlinear Luminance), or an intensity value that is not related to color. */
-  IM_BINARY, /**< Indexed by 2 colors: black (0) and white (1) (data_type=IM_BYTE).     */
-  IM_CMYK,   /**< Cian, Magenta, Yellow and Black (nonlinear).                          */
-  IM_YCBCR,  /**< ITU-R 601 Y'CbCr. Y' is luma (nonlinear Luminance).                   */
-  IM_LAB,    /**< CIE L*a*b*. L* is Lightness (nonlinear Luminance, nearly perceptually uniform). */
-  IM_LUV,    /**< CIE L*u*v*. L* is Lightness (nonlinear Luminance, nearly perceptually uniform). */
-  IM_XYZ     /**< CIE XYZ. Linear Light Tristimulus, Y is linear Luminance.             */
-};
-
-/** Image color mode configuration/extra descriptors (1 bit each in the second byte). \n
- * See also \ref colormodeutl.
- * \ingroup imagerep */
-enum imColorModeConfig
-{
-  IM_ALPHA    = 0x100,  /**< adds an Alpha channel */
-  IM_PACKED   = 0x200,  /**< packed components (rgbrgbrgb...) */
-  IM_TOPDOWN  = 0x400   /**< orientation from top down to bottom */
-};
-
-
-
-/** File Access Error Codes
- * \ingroup file */
-enum imErrorCodes	
-{
-  IM_ERR_NONE,     /**< No error. */
-  IM_ERR_OPEN,     /**< Error while opening the file (read or write). */
-  IM_ERR_ACCESS,   /**< Error while accessing the file (read or write). */
-  IM_ERR_FORMAT,   /**< Invalid or unrecognized file format. */
-  IM_ERR_DATA,     /**< Invalid or unsupported data. */
-  IM_ERR_COMPRESS, /**< Invalid or unsupported compression. */
-  IM_ERR_MEM,      /**< Insuficient memory */
-  IM_ERR_COUNTER   /**< Interrupted by the counter */
-};
-
-/* Internal Image File Structure. */
-typedef struct _imFile imFile;
-
-/** Opens the file for reading. It must exists. Also reads file header.
- * It will try to identify the file format.
- * See also \ref imErrorCodes. \n
- * In Lua the IM file metatable name is "imFile".
- * When converted to a string will return "imFile(%p)" where %p is replaced by the userdata address.
- * If the file is already closed by im.FileClose, then it will return also the suffix "-closed".
- *
- * \verbatim im.FileOpen(file_name: string) -> ifile: imFile, error: number [in Lua 5] \endverbatim
- * \ingroup file */
-imFile* imFileOpen(const char* file_name, int *error);
-
-/** Opens the file for reading using a specific format. It must exists. Also reads file header.
- * See also \ref imErrorCodes and \ref format.
- *
- * \verbatim im.FileOpenAs(file_name, format: string) -> ifile: imFile, error: number [in Lua 5] \endverbatim
- * \ingroup file */
-imFile* imFileOpenAs(const char* file_name, const char* format, int *error);
-
-/** Creates a new file for writing using a specific format. If the file exists will be replaced. \n
- * It will only initialize the format driver and create the file, no data is actually written.
- * See also \ref imErrorCodes and \ref format.
- *
- * \verbatim im.FileNew(file_name: string, format: string) -> ifile: imFile, error: number [in Lua 5] \endverbatim
- * \ingroup file */
-imFile* imFileNew(const char* file_name, const char* format, int *error);
-
-/** Closes the file. \n
- * In Lua if this function is not called, the file is closed by the garbage collector.
- *
- * \verbatim im.FileClose(ifile: imFile) [in Lua 5] \endverbatim
- * \verbatim ifile:Close() [in Lua 5] \endverbatim
- * \ingroup file */
-void imFileClose(imFile* ifile);  
-
-/** Returns an internal handle.
- * index=0 returns always an imBinFile* handle, 
- * but for some formats returns NULL because they do not use imBinFile (like AVI and WMV).
- * index=1 return an internal structure used by the format, usually is a handle 
- * to a third party library structure. This is file format dependent.
- *
- * \verbatim ifile:Handle() -> handle: userdata [in Lua 5] \endverbatim
- * \ingroup file */
-void* imFileHandle(imFile* ifile, int index);  
-
-/** Returns file information. 
- *  image_count is the number of images in a stack or 
- *  the number of frames in a video/animation or the depth of a volume data. \n
- *  compression and image_count can be NULL.
- * See also \ref format.
- *
- * \verbatim ifile:GetInfo() -> format: string, compression: string, image_count: number [in Lua 5] \endverbatim
- * \ingroup file */
-void imFileGetInfo(imFile* ifile, char* format, char* compression, int *image_count);
-
-/** Changes the write compression method. \n
- * If the compression is not supported will return an error code when writting. \n
- * Use NULL to set the default compression. You can use the imFileGetInfo to retrieve the actual compression
- * but only after \ref imFileWriteImageInfo. Only a few formats allow you to change the compression between frames.
- *
- * \verbatim ifile:SetInfo(compression: string) [in Lua 5] \endverbatim
- * \ingroup file */
-void imFileSetInfo(imFile* ifile, const char* compression);
-
-/** Changes an extended attribute. \n
- * The data will be internally duplicated. \n
- * If data is NULL the attribute is removed.
- * See also \ref imDataType.
- *
- * \verbatim ifile:SetAttribute(attrib: string, data_type: number, data: table of numbers or string) [in Lua 5] \endverbatim
- * If data_type is IM_BYTE, as_string can be used as data.
- * \ingroup file */
-void imFileSetAttribute(imFile* ifile, const char* attrib, int data_type, int count, const void* data);
-
-/** Returns an extended attribute. \n
- * Returns NULL if not found. data_type and count can be NULL.
- * See also \ref imDataType.
- *
- * \verbatim ifile:GetAttribute(attrib: string, [as_string: boolean]) -> data: table of numbers or string, data_type: number [in Lua 5] \endverbatim
- * If data_type is IM_BYTE, as_string can be used to return a string instead of a table.
- * \ingroup file */
-const void* imFileGetAttribute(imFile* ifile, const char* attrib, int *data_type, int *count);
-
-/** Returns a list of the attribute names. \n
- * "attrib" must contain room enough for "attrib_count" names. Use "attrib=NULL" to return only the count.
- *
- * \verbatim ifile:GetAttributeList() -> data: table of strings [in Lua 5] \endverbatim
- * \ingroup file */
-void imFileGetAttributeList(imFile* ifile, char** attrib, int *attrib_count);
-
-/** Returns the pallete if any. \n
- * "palette" must be a 256 colors alocated array. \n
- * Returns zero in "palette_count" if there is no palette. "palette_count" is >0 and <=256.
- *
- * \verbatim ifile:GetPalette() -> palette: imPalette [in Lua 5] \endverbatim
- * \ingroup file */
-void imFileGetPalette(imFile* ifile, long* palette, int *palette_count);
-
-/** Changes the pallete. \n
- *  "palette_count" is >0 and <=256.
- *
- * \verbatim ifile:SetPalette(palette: imPalette) [in Lua 5] \endverbatim
- * \ingroup file */
-void imFileSetPalette(imFile* ifile, long* palette, int palette_count);
-
-/** Reads the image header if any and returns image information. \n
- * Reads also the extended image attributes, so other image attributes will be available only after calling this function. \n
- * Returns an error code.
- * index specifies the image number between 0 and image_count-1. \n
- * Some drivers reads only in sequence, so "index" can be ignored by the format driver. \n
- * Any parameters can be NULL. This function must be called at least once, check each format documentation.
- * See also \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
- *
- * \verbatim ifile:ReadImageInfo([index: number]) -> error: number, width: number, height: number, file_color_mode: number, file_data_type: number [in Lua 5] \endverbatim
- * Default index is 0.
- * \ingroup file */
-int imFileReadImageInfo(imFile* ifile, int index, int *width, int *height, int *file_color_mode, int *file_data_type);
-
-/** Writes the image header. Writes the file header at the first time it is called.
- * Writes also the extended image attributes. \n
- * Must call imFileSetPalette and set other attributes before calling this function. \n
- * In some formats the color space will be converted to match file format specification. \n
- * Returns an error code. This function must be called at least once, check each format documentation.
- * See also \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
- *
- * \verbatim ifile:WriteImageInfo(width: number, height: number, user_color_mode: number, user_data_type: number) -> error: number [in Lua 5] \endverbatim
- * \ingroup file */
-int imFileWriteImageInfo(imFile* ifile, int width, int height, int user_color_mode, int user_data_type);
-
-/** Reads the image data with or without conversion. \n
- * The data can be converted to bitmap when reading.
- * Data type conversion to byte will always scan for min-max then scale to 0-255, 
- * except integer values that min-max are already between 0-255. Complex to real conversions will use the magnitude. \n
- * Color mode flags contains packed, alpha and top-botttom information.
- * If flag is 0 means unpacked, no alpha and bottom up. If flag is -1 the file original flags are used. \n
- * Returns an error code.
- * See also \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
- *
- * \verbatim ifile:ReadImageData(data: userdata, convert2bitmap: bool, color_mode_flags: number) -> error: number [in Lua 5] \endverbatim
- * \ingroup file */
-int imFileReadImageData(imFile* ifile, void* data, int convert2bitmap, int color_mode_flags);
-                           
-/** Writes the image data. \n
- * Returns an error code.
- *
- * \verbatim ifile:WriteImageData(data: userdata) -> error: number [in Lua 5] \endverbatim
- * \ingroup file */
-int imFileWriteImageData(imFile* ifile, void* data);
-
-
-
-
-/** Registers all the internal formats. \n
- * It is automatically called internally when a format is accessed, 
- * but can be called to force the internal formats to be registered before other formats.
- * Notice that additional formats when registered will be registered before the internal formats 
- * if imFormatRegisterInternal is not called yet. \n
- * To control the register order is usefull when two format drivers handle the same format. 
- * The first registered format will always be used first.
- * \ingroup format */
-void imFormatRegisterInternal(void);
-
-/** Remove all registered formats.
- * \ingroup format */
-void imFormatRemoveAll(void);
-
-/** Returns a list of the registered formats. \n
- * format_list is an array of format identifiers. 
- * Each format identifier is 10 chars max, maximum of 50 formats. 
- * You can use "char* format_list[50]". 
- *
- * \verbatim im.FormatList() -> format_list: table of strings [in Lua 5] \endverbatim
- * \ingroup format */
-void imFormatList(char** format_list, int *format_count);
-
-/** Returns the format description. \n
- * Format description is 50 chars max. \n
- * Extensions are separated like "*.tif;*.tiff;", 50 chars max. \n
- * Returns an error code. The parameters can be NULL, except format.
- * See also \ref format.
- *
- * \verbatim im.FormatInfo(format: string) -> error: number, desc: string, ext: string, can_sequence: boolean [in Lua 5] \endverbatim
- * \ingroup format */
-int imFormatInfo(const char* format, char* desc, char* ext, int *can_sequence);
-
-/** Returns the format compressions. \n
- * Compressions are 20 chars max each, maximum of 50 compressions. You can use "char* comp[50]". \n
- * color_mode and data_type are optional, use -1 to ignore them. \n
- * If you use them they will select only the allowed compressions checked like in \ref imFormatCanWriteImage. \n
- * Returns an error code.
- * See also \ref format, \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
- *
- * \verbatim im.FormatCompressions(format: string, [color_mode: number], [data_type: number]) -> error: number, comp: table of strings [in Lua 5] \endverbatim
- * \ingroup format */
-int imFormatCompressions(const char* format, char** comp, int *comp_count, int color_mode, int data_type);
-
-/** Checks if the format suport the given image class at the given compression. \n
- * Returns an error code.
- * See also \ref format, \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
- *
- * \verbatim im.FormatCanWriteImage(format: string, compression: string, color_mode: number, data_type: number) -> can_write: boolean [in Lua 5] \endverbatim
- * \ingroup format */
-int imFormatCanWriteImage(const char* format, const char* compression, int color_mode, int data_type);
-
-
-#if defined(__cplusplus)
-}
-#endif
-
-#include "old_im.h"
-
-#endif
+/** \file
+ * \brief Main API
+ *
+ * See Copyright Notice in im_lib.h
+ */
+
+#ifndef __IM_H
+#define __IM_H
+
+#if	defined(__cplusplus)
+extern "C" {
+#endif
+      
+
+/** Image data type descriptors. \n
+ * See also \ref datatypeutl.
+ * \ingroup imagerep */
+enum imDataType
+{
+  IM_BYTE,   /**< "unsigned char". 1 byte from 0 to 255.                  */
+  IM_USHORT, /**< "unsigned short". 2 bytes from 0 to 65,535.             */
+  IM_INT,    /**< "int". 4 bytes from -2,147,483,648 to 2,147,483,647.    */
+  IM_FLOAT,  /**< "float". 4 bytes single precision IEEE floating point.  */
+  IM_CFLOAT  /**< complex "float". 2 float values in sequence, real and imaginary parts.   */
+};
+
+/** Image color mode color space descriptors (first byte). \n
+ * See also \ref colormodeutl.
+ * \ingroup imagerep */
+enum imColorSpace
+{
+  IM_RGB,    /**< Red, Green and Blue (nonlinear).              */
+  IM_MAP,    /**< Indexed by RGB color map (data_type=IM_BYTE). */
+  IM_GRAY,   /**< Shades of gray, luma (nonlinear Luminance), or an intensity value that is not related to color. */
+  IM_BINARY, /**< Indexed by 2 colors: black (0) and white (1) (data_type=IM_BYTE).     */
+  IM_CMYK,   /**< Cian, Magenta, Yellow and Black (nonlinear).                          */
+  IM_YCBCR,  /**< ITU-R 601 Y'CbCr. Y' is luma (nonlinear Luminance).                   */
+  IM_LAB,    /**< CIE L*a*b*. L* is Lightness (nonlinear Luminance, nearly perceptually uniform). */
+  IM_LUV,    /**< CIE L*u*v*. L* is Lightness (nonlinear Luminance, nearly perceptually uniform). */
+  IM_XYZ     /**< CIE XYZ. Linear Light Tristimulus, Y is linear Luminance.             */
+};
+
+/** Image color mode configuration/extra descriptors (1 bit each in the second byte). \n
+ * See also \ref colormodeutl.
+ * \ingroup imagerep */
+enum imColorModeConfig
+{
+  IM_ALPHA    = 0x100,  /**< adds an Alpha channel */
+  IM_PACKED   = 0x200,  /**< packed components (rgbrgbrgb...) */
+  IM_TOPDOWN  = 0x400   /**< orientation from top down to bottom */
+};
+
+
+
+/** File Access Error Codes
+ * \ingroup file */
+enum imErrorCodes	
+{
+  IM_ERR_NONE,     /**< No error. */
+  IM_ERR_OPEN,     /**< Error while opening the file (read or write). */
+  IM_ERR_ACCESS,   /**< Error while accessing the file (read or write). */
+  IM_ERR_FORMAT,   /**< Invalid or unrecognized file format. */
+  IM_ERR_DATA,     /**< Invalid or unsupported data. */
+  IM_ERR_COMPRESS, /**< Invalid or unsupported compression. */
+  IM_ERR_MEM,      /**< Insuficient memory */
+  IM_ERR_COUNTER   /**< Interrupted by the counter */
+};
+
+/* Internal Image File Structure. */
+typedef struct _imFile imFile;
+
+/** Opens the file for reading. It must exists. Also reads file header.
+ * It will try to identify the file format.
+ * See also \ref imErrorCodes. \n
+ * In Lua the IM file metatable name is "imFile".
+ * When converted to a string will return "imFile(%p)" where %p is replaced by the userdata address.
+ * If the file is already closed by im.FileClose, then it will return also the suffix "-closed".
+ *
+ * \verbatim im.FileOpen(file_name: string) -> ifile: imFile, error: number [in Lua 5] \endverbatim
+ * \ingroup file */
+imFile* imFileOpen(const char* file_name, int *error);
+
+/** Opens the file for reading using a specific format. It must exists. Also reads file header.
+ * See also \ref imErrorCodes and \ref format.
+ *
+ * \verbatim im.FileOpenAs(file_name, format: string) -> ifile: imFile, error: number [in Lua 5] \endverbatim
+ * \ingroup file */
+imFile* imFileOpenAs(const char* file_name, const char* format, int *error);
+
+/** Creates a new file for writing using a specific format. If the file exists will be replaced. \n
+ * It will only initialize the format driver and create the file, no data is actually written.
+ * See also \ref imErrorCodes and \ref format.
+ *
+ * \verbatim im.FileNew(file_name: string, format: string) -> ifile: imFile, error: number [in Lua 5] \endverbatim
+ * \ingroup file */
+imFile* imFileNew(const char* file_name, const char* format, int *error);
+
+/** Closes the file. \n
+ * In Lua if this function is not called, the file is closed by the garbage collector.
+ *
+ * \verbatim im.FileClose(ifile: imFile) [in Lua 5] \endverbatim
+ * \verbatim ifile:Close() [in Lua 5] \endverbatim
+ * \ingroup file */
+void imFileClose(imFile* ifile);  
+
+/** Returns an internal handle.
+ * index=0 returns always an imBinFile* handle, 
+ * but for some formats returns NULL because they do not use imBinFile (like AVI and WMV).
+ * index=1 return an internal structure used by the format, usually is a handle 
+ * to a third party library structure. This is file format dependent.
+ *
+ * \verbatim ifile:Handle() -> handle: userdata [in Lua 5] \endverbatim
+ * \ingroup file */
+void* imFileHandle(imFile* ifile, int index);  
+
+/** Returns file information. 
+ * image_count is the number of images in a stack or 
+ * the number of frames in a video/animation or the depth of a volume data. \n
+ * compression and image_count can be NULL. \n
+ * These informations are also available as attributes:
+ * \verbatim FileFormat (string) \endverbatim
+ * \verbatim FileCompression (string) \endverbatim
+ * \verbatim FileImageCount IM_INT (1) \endverbatim
+ * See also \ref format.
+ *
+ * \verbatim ifile:GetInfo() -> format: string, compression: string, image_count: number [in Lua 5] \endverbatim
+ * \ingroup file */
+void imFileGetInfo(imFile* ifile, char* format, char* compression, int *image_count);
+
+/** Changes the write compression method. \n
+ * If the compression is not supported will return an error code when writting. \n
+ * Use NULL to set the default compression. You can use the imFileGetInfo to retrieve the actual compression
+ * but only after \ref imFileWriteImageInfo. Only a few formats allow you to change the compression between frames.
+ *
+ * \verbatim ifile:SetInfo(compression: string) [in Lua 5] \endverbatim
+ * \ingroup file */
+void imFileSetInfo(imFile* ifile, const char* compression);
+
+/** Changes an extended attribute. \n
+ * The data will be internally duplicated. \n
+ * If data is NULL the attribute is removed. 
+ * If data_type is BYTE then count can be -1 to indicate a NULL terminated string.
+ * See also \ref imDataType.
+ *
+ * \verbatim ifile:SetAttribute(attrib: string, data_type: number, data: table of numbers or string) [in Lua 5] \endverbatim
+ * If data_type is IM_BYTE, as_string can be used as data.
+ * \ingroup file */
+void imFileSetAttribute(imFile* ifile, const char* attrib, int data_type, int count, const void* data);
+
+/** Returns an extended attribute. \n
+ * Returns NULL if not found. data_type and count can be NULL.
+ * See also \ref imDataType.
+ *
+ * \verbatim ifile:GetAttribute(attrib: string, [as_string: boolean]) -> data: table of numbers or string, data_type: number [in Lua 5] \endverbatim
+ * If data_type is IM_BYTE, as_string can be used to return a string instead of a table.
+ * \ingroup file */
+const void* imFileGetAttribute(imFile* ifile, const char* attrib, int *data_type, int *count);
+
+/** Returns a list of the attribute names. \n
+ * "attrib" must contain room enough for "attrib_count" names. Use "attrib=NULL" to return only the count.
+ *
+ * \verbatim ifile:GetAttributeList() -> data: table of strings [in Lua 5] \endverbatim
+ * \ingroup file */
+void imFileGetAttributeList(imFile* ifile, char** attrib, int *attrib_count);
+
+/** Returns the pallete if any. \n
+ * "palette" must be a 256 colors alocated array. \n
+ * Returns zero in "palette_count" if there is no palette. "palette_count" is >0 and <=256.
+ *
+ * \verbatim ifile:GetPalette() -> palette: imPalette [in Lua 5] \endverbatim
+ * \ingroup file */
+void imFileGetPalette(imFile* ifile, long* palette, int *palette_count);
+
+/** Changes the pallete. \n
+ *  "palette_count" is >0 and <=256.
+ *
+ * \verbatim ifile:SetPalette(palette: imPalette) [in Lua 5] \endverbatim
+ * \ingroup file */
+void imFileSetPalette(imFile* ifile, long* palette, int palette_count);
+
+/** Reads the image header if any and returns image information. \n
+ * Reads also the extended image attributes, so other image attributes will be available only after calling this function. \n
+ * Returns an error code.
+ * index specifies the image number between 0 and image_count-1. \n
+ * Some drivers reads only in sequence, so "index" can be ignored by the format driver. \n
+ * Any parameters can be NULL. This function must be called at least once, check each format documentation.
+ * See also \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
+ *
+ * \verbatim ifile:ReadImageInfo([index: number]) -> error: number, width: number, height: number, file_color_mode: number, file_data_type: number [in Lua 5] \endverbatim
+ * Default index is 0.
+ * \ingroup file */
+int imFileReadImageInfo(imFile* ifile, int index, int *width, int *height, int *file_color_mode, int *file_data_type);
+
+/** Writes the image header. Writes the file header at the first time it is called.
+ * Writes also the extended image attributes. \n
+ * Must call imFileSetPalette and set other attributes before calling this function. \n
+ * In some formats the color space will be converted to match file format specification. \n
+ * Returns an error code. This function must be called at least once, check each format documentation.
+ * See also \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
+ *
+ * \verbatim ifile:WriteImageInfo(width: number, height: number, user_color_mode: number, user_data_type: number) -> error: number [in Lua 5] \endverbatim
+ * \ingroup file */
+int imFileWriteImageInfo(imFile* ifile, int width, int height, int user_color_mode, int user_data_type);
+
+/** Reads the image data with or without conversion. \n
+ * The data can be converted to bitmap when reading.
+ * Data type conversion to byte will always scan for min-max then scale to 0-255, 
+ * except integer values that min-max are already between 0-255. Complex to real conversions will use the magnitude. \n
+ * Color mode flags contains packed, alpha and top-botttom information.
+ * If flag is 0 means unpacked, no alpha and bottom up. If flag is -1 the file original flags are used. \n
+ * Returns an error code.
+ * See also \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
+ *
+ * \verbatim ifile:ReadImageData(data: userdata, convert2bitmap: boolean, color_mode_flags: number) -> error: number [in Lua 5] \endverbatim
+ * \ingroup file */
+int imFileReadImageData(imFile* ifile, void* data, int convert2bitmap, int color_mode_flags);
+                           
+/** Writes the image data. \n
+ * Returns an error code.
+ *
+ * \verbatim ifile:WriteImageData(data: userdata) -> error: number [in Lua 5] \endverbatim
+ * \ingroup file */
+int imFileWriteImageData(imFile* ifile, void* data);
+
+
+
+
+/** Registers all the internal formats. \n
+ * It is automatically called internally when a format is accessed, 
+ * but can be called to force the internal formats to be registered before other formats.
+ * Notice that additional formats when registered will be registered before the internal formats 
+ * if imFormatRegisterInternal is not called yet. \n
+ * To control the register order is usefull when two format drivers handle the same format. 
+ * The first registered format will always be used first.
+ * \ingroup format */
+void imFormatRegisterInternal(void);
+
+/** Remove all registered formats. Call this if you are checking memory leaks.
+ * \ingroup format */
+void imFormatRemoveAll(void);
+
+/** Returns a list of the registered formats. \n
+ * format_list is an array of format identifiers. 
+ * Each format identifier is 10 chars max, maximum of 50 formats. 
+ * You can use "char* format_list[50]". 
+ *
+ * \verbatim im.FormatList() -> format_list: table of strings [in Lua 5] \endverbatim
+ * \ingroup format */
+void imFormatList(char** format_list, int *format_count);
+
+/** Returns the format description. \n
+ * Format description is 50 chars max. \n
+ * Extensions are separated like "*.tif;*.tiff;", 50 chars max. \n
+ * Returns an error code. The parameters can be NULL, except format.
+ * See also \ref format.
+ *
+ * \verbatim im.FormatInfo(format: string) -> error: number, desc: string, ext: string, can_sequence: boolean [in Lua 5] \endverbatim
+ * \ingroup format */
+int imFormatInfo(const char* format, char* desc, char* ext, int *can_sequence);
+
+/** Returns the format compressions. \n
+ * Compressions are 20 chars max each, maximum of 50 compressions. You can use "char* comp[50]". \n
+ * color_mode and data_type are optional, use -1 to ignore them. \n
+ * If you use them they will select only the allowed compressions checked like in \ref imFormatCanWriteImage. \n
+ * Returns an error code.
+ * See also \ref format, \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
+ *
+ * \verbatim im.FormatCompressions(format: string, [color_mode: number], [data_type: number]) -> error: number, comp: table of strings [in Lua 5] \endverbatim
+ * \ingroup format */
+int imFormatCompressions(const char* format, char** comp, int *comp_count, int color_mode, int data_type);
+
+/** Checks if the format suport the given image class at the given compression. \n
+ * Returns an error code.
+ * See also \ref format, \ref imErrorCodes, \ref imDataType, \ref imColorSpace and \ref imColorModeConfig.
+ *
+ * \verbatim im.FormatCanWriteImage(format: string, compression: string, color_mode: number, data_type: number) -> can_write: boolean [in Lua 5] \endverbatim
+ * \ingroup format */
+int imFormatCanWriteImage(const char* format, const char* compression, int color_mode, int data_type);
+
+
+#if defined(__cplusplus)
+}
+#endif
+
+#include "old_im.h"
+
+#endif