1 files changed, 117 insertions, 17 deletions

diff --git a/ue2/imgsynth2/cbitmap.h b/ue2/imgsynth2/cbitmap.h
index f521bcc..c8d4dfb 100644
--- a/ue2/imgsynth2/cbitmap.h
+++ b/ue2/imgsynth2/cbitmap.h
@@ -10,10 +10,7 @@
 
 #include <stdint.h>
 #include <map>
-#include <string>
 #include "cfile.h"
-
-class CPixelFormat;
 #include "cpixelformat.h"
 
 /**
@@ -55,12 +52,28 @@ class CBitmap : public CFile
     virtual ~CBitmap();
 
     /**
-     * TODO
+     * @method read
+     * @brief  Reads Windows Bitmap from filestream.
+     *         On error an exception is thrown.
+     * @param  in filestream to read data from
+     * @return -
+     * @globalvars none
+     * @exception CFile::FileError
+     * @exception bad_alloc
+     * @conditions none
      */
     virtual void read(std::ifstream& in) = 0;
 
     /**
-     * TODO
+     * @method write
+     * @brief  Writes Windows Bitmap to filestream.
+     * @param  out      filestream to read data from
+     * @param  filename filename (maybe useful for some handlers)
+     * @return -
+     * @globalvars none
+     * @exception  FileError
+     * @exception  bad_alloc
+     * @conditions none
      */
     virtual void write(std::ofstream& out, std::string& filename) = 0;
 
@@ -78,15 +91,62 @@ class CBitmap : public CFile
       return m_pixeldata;
     }
 
-    /* TODO */
+    /**
+     * @method getPixelDataSize
+     * @brief  Return size of pixelbuffer
+     * @param  -
+     * @return size of pixelbuffer
+     * @globalvars none
+     * @exception  none
+     * @conditions none
+     */
     virtual const uint32_t getPixelDataSize() = 0;
-    /* TODO */
+
+    /**
+     * @method getHeight
+     * @brief  Return height of bitmap in pixel
+     * @param  -
+     * @return height of bitmap in pixel
+     * @globalvars none
+     * @exception  none
+     * @conditions none
+     */
     virtual const uint32_t getHeight() = 0;
-    /* TODO */
+
+    /**
+     * @method getWidth
+     * @brief  Return width of bitmap in pixel
+     * @param  -
+     * @return width of bitmap in pixel
+     * @globalvars none
+     * @exception  none
+     * @conditions none
+     */
     virtual const uint32_t getWidth() = 0;
-    /* TODO */
+
+    /**
+     * @method isMirrored
+     * @brief  Windows Bitmaps can be stored upside down
+     * @param  -
+     * @return true if bitmap is stored upside down. false otherwise
+     * @globalvars none
+     * @exception  none
+     * @conditions none
+     */
     virtual const bool isMirrored() = 0;
 
+    /**
+     * @method hasColorTable
+     * @brief  Check if bitmap has a colortable
+     *         (we don't support this yet for windows bitmaps)
+     * @param  -
+     * @return true if bitmap has a colortable. false otherwise
+     * @globalvars none
+     * @exception  none
+     * @conditions none
+     */
+    virtual const bool hasColorTable() = 0;
+
   protected:
     /**
      * @method callFunc
@@ -101,7 +161,7 @@ class CBitmap : public CFile
      */
     void callFunc(const std::string& func, const std::list<std::string>& params);
 
-   /**
+    /**
      * @method fillrect
      * @brief  Fills rectangle in image starting on position x, y
      *         width size width, height and color red, green, blue.
@@ -115,28 +175,68 @@ class CBitmap : public CFile
      */
     void fillrect(std::list<std::string> params);
 
-    /* TODO */
+    /**
+     * @method invert
+     * @brief  Invert image
+     * @param  params function parameters as list
+     * @return -
+     * @globalvars none
+     * @exception  FileError
+     * @conditions none
+     *
+     * Scriptfile syntax: invert()
+     */
     void invert(std::list<std::string> params);
 
-    /* TODO */
+    /**
+     * @method brightness
+     * @brief  Increase/decrease brightness of image
+     * @param  params function parameters as list
+     * @return -
+     * @globalvars none
+     * @exception  FileError
+     * @conditions none
+     *
+     * Scriptfile syntax: brightness(factor)
+     */
     void brightness(std::list<std::string> params);
 
-    /* TODO */
+    /**
+     * @method mirror_y
+     * @brief  Mirror image around the y-axis
+     * @param  params function parameters as list
+     * @return -
+     * @globalvars none
+     * @exception  FileError
+     * @conditions none
+     *
+     * Scriptfile syntax: mirror_y()
+     */
     void mirror_y(std::list<std::string> params);
 
-    /* TODO */
+    /**
+     * @method mirror_x
+     * @brief  Mirror image around the x-axis
+     * @param  params function parameters as list
+     * @return -
+     * @globalvars none
+     * @exception  FileError
+     * @conditions none
+     *
+     * Scriptfile syntax: mirror_y()
+     */
     void mirror_x(std::list<std::string> params);
 
     /* members */
     /** pointer to pixelbuffer */
     uint8_t *m_pixeldata;
+    /** colortable map */
+    //TODO std::map<std::string, CPixelFormat::RGBPIXEL *> m_colortable;
+    std::map<std::string, std::map< std::string, uint32_t* > > xpmColors;
     /** set of supported PixelFormat handlers */
     std::set<CPixelFormat *> m_handlers;
     /** pointer to CPixelFormat implementation */
     CPixelFormat *m_pixelformat;
-    /* color table */
-    std::map<std::string, std::map< std::string, uint32_t* > > xpmColors;
-    
 };
 
 #endif