awful.completion: doc fixes
[awesome.git] / image.c
blob23133289da589f6f4b0ced638e30012688b59caa
1 /*
2 * image.c - image object
4 * Copyright © 2008 Julien Danjou <julien@danjou.info>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "structs.h"
24 extern awesome_t globalconf;
26 DO_LUA_NEW(extern, image_t, image, "image", image_ref)
27 DO_LUA_GC(image_t, image, "image", image_unref)
28 DO_LUA_EQ(image_t, image, "image")
30 static const char *
31 image_imlib_load_strerror(Imlib_Load_Error e)
33 switch(e)
35 case IMLIB_LOAD_ERROR_FILE_DOES_NOT_EXIST:
36 return "no such file or directory";
37 case IMLIB_LOAD_ERROR_FILE_IS_DIRECTORY:
38 return "file is a directory";
39 case IMLIB_LOAD_ERROR_PERMISSION_DENIED_TO_READ:
40 return "read permission denied";
41 case IMLIB_LOAD_ERROR_NO_LOADER_FOR_FILE_FORMAT:
42 return "no loader for file format";
43 case IMLIB_LOAD_ERROR_PATH_TOO_LONG:
44 return "path too long";
45 case IMLIB_LOAD_ERROR_PATH_COMPONENT_NON_EXISTANT:
46 return "path component non existant";
47 case IMLIB_LOAD_ERROR_PATH_COMPONENT_NOT_DIRECTORY:
48 return "path compoment not a directory";
49 case IMLIB_LOAD_ERROR_PATH_POINTS_OUTSIDE_ADDRESS_SPACE:
50 return "path points oustide address space";
51 case IMLIB_LOAD_ERROR_TOO_MANY_SYMBOLIC_LINKS:
52 return "too many symbolic links";
53 case IMLIB_LOAD_ERROR_OUT_OF_MEMORY:
54 return "out of memory";
55 case IMLIB_LOAD_ERROR_OUT_OF_FILE_DESCRIPTORS:
56 return "out of file descriptors";
57 case IMLIB_LOAD_ERROR_PERMISSION_DENIED_TO_WRITE:
58 return "write permission denied";
59 case IMLIB_LOAD_ERROR_OUT_OF_DISK_SPACE:
60 return "out of disk space";
61 case IMLIB_LOAD_ERROR_UNKNOWN:
62 return "unknown error, that's really bad";
63 case IMLIB_LOAD_ERROR_NONE:
64 return "no error, oops";
67 return "unknown error";
70 /** Recompute the ARGB32 data from an image.
71 * \param image The image.
72 * \return Data.
74 static void
75 image_compute(image_t *image)
77 int size, i;
78 uint32_t *data;
79 double alpha;
80 uint8_t *dataimg;
82 imlib_context_set_image(image->image);
84 data = imlib_image_get_data_for_reading_only();
86 image->width = imlib_image_get_width();
87 image->height = imlib_image_get_height();
89 size = image->width * image->height;
91 p_delete(&image->data);
92 image->data = dataimg = p_new(uint8_t, size * 4);
94 for(i = 0; i < size; i++, dataimg += 4)
96 dataimg[3] = (data[i] >> 24) & 0xff; /* A */
97 /* cairo wants pre-multiplied alpha */
98 alpha = dataimg[3] / 255.0;
99 dataimg[2] = ((data[i] >> 16) & 0xff) * alpha; /* R */
100 dataimg[1] = ((data[i] >> 8) & 0xff) * alpha; /* G */
101 dataimg[0] = (data[i] & 0xff) * alpha; /* B */
105 /** Create a new image from ARGB32 data.
106 * \param width The image width.
107 * \param height The image height.
108 * \param data The image data.
109 * \return A brand new image.
111 image_t *
112 image_new_from_argb32(int width, int height, uint32_t *data)
114 Imlib_Image imimage;
115 image_t *image = NULL;
117 if((imimage = imlib_create_image_using_data(width, height, data)))
119 image = p_new(image_t, 1);
120 image->image = imimage;
121 image_compute(image);
124 return image;
127 /** Load an image from filename.
128 * \param filename The image file to load.
129 * \return A new image.
131 image_t *
132 image_new_from_file(const char *filename)
134 Imlib_Image imimage;
135 Imlib_Load_Error e = IMLIB_LOAD_ERROR_NONE;
136 image_t *image;
138 if(!filename)
139 return NULL;
141 if(!(imimage = imlib_load_image_with_error_return(filename, &e)))
143 warn("cannot load image %s: %s", filename, image_imlib_load_strerror(e));
144 return NULL;
147 image = p_new(image_t, 1);
148 image->image = imimage;
150 image_compute(image);
152 return image;
155 /** Create a new image object.
156 * \param L The Lua stack.
157 * \return The number of elements pushed on stack.
158 * \luastack
159 * \lparam The image path, or nil to create an empty image.
160 * \lparam The image width if nil was set as first arg.
161 * \lparam The image height if nil was set as first arg.
162 * \lreturn An image object.
164 static int
165 luaA_image_new(lua_State *L)
167 const char *filename;
169 if((filename = lua_tostring(L, 2)))
171 image_t *image;
172 if((image = image_new_from_file(filename)))
173 return luaA_image_userdata_new(L, image);
175 else if(lua_isnil(L, 2))
177 int width = luaL_checknumber(L, 3);
178 int height = luaL_checknumber(L, 4);
179 Imlib_Image imimage = imlib_create_image(width, height);
180 image_t *image = p_new(image_t, 1);
181 image->image = imimage;
182 image_compute(image);
183 return luaA_image_userdata_new(L, image);
186 return 0;
189 /** Create a new image object from ARGB32 data.
190 * \param L The Lua stack.
191 * \return The number of elements pushed on stack.
192 * \luastack
193 * \lparam The image width.
194 * \lparam The image height.
195 * \lparam The image data as a string in ARGB32 format.
196 * \lreturn An image object.
198 static int
199 luaA_image_argb32_new(lua_State *L)
201 size_t len;
202 image_t *image;
203 unsigned int width = luaL_checknumber(L, 1);
204 unsigned int height = luaL_checknumber(L, 2);
205 const char *data = luaL_checklstring(L, 3, &len);
207 if(width * height * 4 != len)
208 luaL_error(L, "string size does not match image size");
210 if((image = image_new_from_argb32(width, height, (uint32_t *) data)))
211 return luaA_image_userdata_new(L, image);
213 return 0;
216 /** Rotate an image with specified angle radians and return a new image.
217 * \param L The Lua VM state.
218 * \return The number of elements pushed on stack.
219 * \luastack
220 * \lvalue An image.
221 * \lparam The angle in radians.
222 * \lreturn A rotated image.
224 static int
225 luaA_image_rotate(lua_State *L)
227 image_t **image = luaA_checkudata(L, 1, "image"), *new;
228 double angle = luaL_checknumber(L, 2);
230 new = p_new(image_t, 1);
232 imlib_context_set_image((*image)->image);
233 new->image = imlib_create_rotated_image(angle);
235 image_compute(new);
237 return luaA_image_userdata_new(L, new);
240 /** Crop an image to the given rectangle.
241 * \return The number of elements pushed on stack.
242 * \luastack
243 * \lvalue An image.
244 * \lparam The top left x coordinate of the rectangle.
245 * \lparam The top left y coordinate of the rectangle.
246 * \lparam The width of the rectangle.
247 * \lparam The height of the rectangle.
248 * \lreturn A cropped image.
250 static int
251 luaA_image_crop(lua_State *L)
253 image_t **image = luaA_checkudata(L, 1, "image"), *new;
254 int x = luaL_checkint(L, 2);
255 int y = luaL_checkint(L, 3);
256 int w = luaL_checkint(L, 4);
257 int h = luaL_checkint(L, 5);
259 new = p_new(image_t, 1);
261 imlib_context_set_image((*image)->image);
262 new->image = imlib_create_cropped_image(x, y, w, h);
264 image_compute(new);
266 return luaA_image_userdata_new(L, new);
269 /** Crop the image to the given rectangle and scales it.
270 * \param L The Lua VM state.
271 * \return The number of elements pushed on stack.
272 * \luastack
273 * \lvalue An image.
274 * \lparam The top left x coordinate of the source rectangle.
275 * \lparam The top left y coordinate of the source rectangle.
276 * \lparam The width of the source rectangle.
277 * \lparam The height of the source rectangle.
278 * \lparam The width of the destination rectangle.
279 * \lparam The height of the destination rectangle.
280 * \lreturn A cropped image.
282 static int
283 luaA_image_crop_and_scale(lua_State *L)
285 image_t **image = luaA_checkudata(L, 1, "image"), *new;
286 int source_x = luaL_checkint(L, 2);
287 int source_y = luaL_checkint(L, 3);
288 int w = luaL_checkint(L, 4);
289 int h = luaL_checkint(L, 5);
290 int dest_w = luaL_checkint(L, 6);
291 int dest_h = luaL_checkint(L, 7);
293 new = p_new(image_t, 1);
295 imlib_context_set_image((*image)->image);
296 new->image = imlib_create_cropped_scaled_image(source_x,
297 source_y,
298 w, h,
299 dest_w, dest_h);
301 image_compute(new);
303 return luaA_image_userdata_new(L, new);
306 /** Image object.
307 * \param L The Lua VM state.
308 * \return The number of elements pushed on stack.
309 * \luastack
310 * \lvalue An image
311 * \lfield width The image width.
312 * \lfield height The image height.
314 static int
315 luaA_image_index(lua_State *L)
317 if(luaA_usemetatable(L, 1, 2))
318 return 1;
320 image_t **image = luaA_checkudata(L, 1, "image");
321 size_t len;
322 const char *attr = luaL_checklstring(L, 2, &len);
324 switch(a_tokenize(attr, len))
326 case A_TK_WIDTH:
327 imlib_context_set_image((*image)->image);
328 lua_pushnumber(L, imlib_image_get_width());
329 break;
330 case A_TK_HEIGHT:
331 imlib_context_set_image((*image)->image);
332 lua_pushnumber(L, imlib_image_get_height());
333 break;
334 default:
335 return 0;
338 return 1;
341 const struct luaL_reg awesome_image_methods[] =
343 { "__call", luaA_image_new },
344 { "argb32", luaA_image_argb32_new },
345 { NULL, NULL }
347 const struct luaL_reg awesome_image_meta[] =
349 { "__index", luaA_image_index },
350 { "rotate", luaA_image_rotate },
351 { "crop", luaA_image_crop },
352 { "crop_and_scale", luaA_image_crop_and_scale },
353 { "__gc", luaA_image_gc },
354 { "__eq", luaA_image_eq },
355 { "__tostring", luaA_image_tostring },
356 { NULL, NULL }
359 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80