67bff71999-11-15Jonas Wallden // Button module. Generates graphical buttons for use in Roxen config // interface, Roxen SiteBuilder and other places. //
979f4d2000-03-16Martin Nilsson // Copyright © 1999-2000 Roxen IS. Author: Jonas Walldén, <jonasw@roxen.com>
67bff71999-11-15Jonas Wallden  // Usage: // // <gbutton // bgcolor -- background color inside/outside button // bordercolor -- button border color // textcolor -- button text color // href -- button URL // alt -- alternative button alt text // border -- image border
0b91941999-11-16Jonas Wallden // state -- enabled|disabled button state // textstyle -- normal|consensed text
67bff71999-11-15Jonas Wallden // icon_src -- icon reference // icon_data -- inline icon data // align -- left|center|right text alignment // align_icon -- left|center_before|center_after|right icon alignment // >Button text</gbutton> // // Alignment restriction: when text alignment is either left or right, icons // must also be aligned left or right.
bf956c2000-05-01Martin Nilsson constant cvs_version = "$Id: gbutton.pike,v 1.47 2000/05/01 06:17:36 nilsson Exp $";
67bff71999-11-15Jonas Wallden constant thread_safe = 1; #include <module.h> inherit "module"; roxen.ImageCache button_cache;
c043f82000-02-10Martin Nilsson constant module_type = MODULE_PARSER; constant module_name = "GButton";
76fd092000-04-06Mattias Wingstedt constant module_doc = "Provides the <tt>&lt;gbutton&gt;</tt> tag that is used to draw graphical " "buttons.";
2e0a351999-12-09Martin Nilsson  TAGDOCUMENTATION
5422622000-02-08Martin Nilsson #ifdef manual
bf956c2000-05-01Martin Nilsson constant tagdoc=(["gbutton":#"<desc cont><short>Generates graphical buttons</short></desc>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=bgcolor value=color>Background color inside and outside button.</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=bordercolor value=color>Button border color</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=textcolor value=color>Button text color</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=href value=url>Button URL</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=alt value=string>Alternative button alt text</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=border value=number>Image border</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=state value=enabled|disabled>Set to enabled or disabled to select button state.</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=textstyle value=normal|condensed>Set to normal or condensed to alter text style.</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=icon_src value=path>Icon reference</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=icon_data value=string>Inline icon data</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=align value=left|center|right>Text alignment</attr>
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson <attr name=align_icon value=left|center_before|center_after|right>Icon alignment. There are some alignment restrictions: when text alignment is either left or right, icons must also be aligned left or right.</attr> ",
67bff71999-11-15Jonas Wallden 
bf956c2000-05-01Martin Nilsson "gbutton-url":""]);
2e0a351999-12-09Martin Nilsson #endif
67bff71999-11-15Jonas Wallden 
8a98622000-04-04Per Hedbor function TIMER( function f ) { #if 0 return lambda(mixed ... args) { int h = gethrtime(); mixed res; werror("Drawing ... "); res = f( @args ); werror(" %.1fms\n", (gethrtime()-h)/1000000.0 ); return res; }; #endif return f; }
67bff71999-11-15Jonas Wallden void start() {
8a98622000-04-04Per Hedbor  button_cache = roxen.ImageCache("gbutton", TIMER(draw_button));
67bff71999-11-15Jonas Wallden }
fde9082000-02-08Per Hedbor Image.Layer layer_slice( Image.Layer l, int from, int to ) { return Image.Layer( ([ "image":l->image()->copy( from,0, to-1, l->ysize()-1 ), "alpha":l->alpha()->copy( from,0, to-1, l->ysize()-1 ), ]) ); } Image.Layer stretch_layer( Image.Layer o, int x1, int x2, int w ) { Image.Layer l, m, r; int leftovers = w - (x1 + (o->xsize()-x2) ); object oo = o; l = layer_slice( o, 0, x1 );
3ef6452000-02-08Jonas Wallden  m = layer_slice( o, x1+1, x2-1 );
fde9082000-02-08Per Hedbor  r = layer_slice( o, x2, o->xsize() ); m->set_image( m->image()->scale( leftovers, l->ysize() ), m->alpha()->scale( leftovers, l->ysize() )); l->set_offset( 0,0 ); m->set_offset( x1,0 ); r->set_offset( w-r->xsize(),0 ); o = Image.lay( ({ l, m, r }) );
e0fda72000-04-04Marcus Comstedt  o->set_mode( oo->mode() ); o->set_alpha_value( oo->alpha_value() );
fde9082000-02-08Per Hedbor  return o; }
67bff71999-11-15Jonas Wallden 
1a54422000-02-21Per Hedbor array(Image.Layer) draw_button(mapping args, string text, object id)
67bff71999-11-15Jonas Wallden {
fde9082000-02-08Per Hedbor  Image.Image text_img;
67bff71999-11-15Jonas Wallden  mapping icon;
7169752000-02-02Per Hedbor  object button_font = resolve_font( args->font );
fde9082000-02-08Per Hedbor  Image.Layer background; Image.Layer frame; Image.Layer mask; int left, right, top, bottom; /* offsets */ int req_width;
7169752000-02-02Per Hedbor 
3d3a472000-02-08Per Hedbor  mapping ll = ([]);
fff48a2000-02-21Per Hedbor  void set_image( array layers )
e76d2c2000-02-03Per Hedbor  {
fff48a2000-02-21Per Hedbor  foreach( layers||({}), object l )
fde9082000-02-08Per Hedbor  {
fff48a2000-02-21Per Hedbor  if(!l->get_misc_value( "name" ) ) // Hm. continue; ll[lower_case(l->get_misc_value( "name" ))] = l; switch( lower_case(l->get_misc_value( "name" )) )
fde9082000-02-08Per Hedbor  { case "background": background = l; break; case "frame": frame = l; break; case "mask": mask = l; break; } }
fff48a2000-02-21Per Hedbor  };
5dac1c2000-01-10Martin Nilsson 
fff48a2000-02-21Per Hedbor  if( args->border_image ) set_image( roxen.load_layers(args->border_image, id) ); // otherwise load default images if ( !frame )
f29b142000-03-24Per Hedbor  set_image( roxen.load_layers("/internal-roxen-gbutton", id) );
fff48a2000-02-21Per Hedbor  // Translate frame image to 0,0 (left layers are most likely to the // left of the frame image) int x0 = frame->xoffset(); int y0 = frame->yoffset(); if( x0 || y0 ) foreach( values( ll ), object l ) { int x = l->xoffset(); int y = l->yoffset(); l->set_offset( x-x0, y-y0 ); }
7169752000-02-02Per Hedbor 
fde9082000-02-08Per Hedbor  if( !mask ) mask = frame;
e76d2c2000-02-03Per Hedbor 
fde9082000-02-08Per Hedbor  array x = ({}); array y = ({}); foreach( frame->get_misc_value( "image_guides" ), object g )
8d387a2000-02-11Jonas Wallden  if( g->pos < 4096 ) if( g->vertical )
fff48a2000-02-21Per Hedbor  x += ({ g->pos-x0 });
8d387a2000-02-11Jonas Wallden  else
fff48a2000-02-21Per Hedbor  y += ({ g->pos-y0 }); sort( y ); sort( x );
e76d2c2000-02-03Per Hedbor 
fde9082000-02-08Per Hedbor  if(sizeof( x ) < 2) x = ({ 5, frame->xsize()-5 });
fff48a2000-02-21Per Hedbor 
fde9082000-02-08Per Hedbor  if(sizeof( y ) < 2) y = ({ 2, frame->ysize()-2 });
e76d2c2000-02-03Per Hedbor 
fde9082000-02-08Per Hedbor  left = x[0]; right = x[-1]; top = y[0]; bottom = y[-1]; right = frame->xsize()-right; int text_height = bottom - top;
7169752000-02-02Per Hedbor 
67bff71999-11-15Jonas Wallden  // Get icon if (args->icn) icon = roxen.low_load_image(args->icn, id); else if (args->icd) icon = roxen.low_decode_image(args->icd);
fde9082000-02-08Per Hedbor  int i_width = icon && icon->img->xsize();
3ef6452000-02-08Jonas Wallden  int i_spc = i_width ? 5 : 0;
7169752000-02-02Per Hedbor 
67bff71999-11-15Jonas Wallden  // Generate text
fde9082000-02-08Per Hedbor  if (sizeof(text)) { text_img = button_font->write(text)->scale(0, text_height );
3c24b62000-01-19Fredrik Noring  if (args->cnd) text_img = text_img->scale((int) round(text_img->xsize() * 0.8), text_img->ysize()); }
7169752000-02-02Per Hedbor 
fde9082000-02-08Per Hedbor  int t_width = text_img && text_img->xsize();
67bff71999-11-15Jonas Wallden  // Compute text and icon placement
3ef6452000-02-08Jonas Wallden  req_width = text_img->xsize() + left + right + i_width + i_spc;
944d9e2000-02-08Per Hedbor 
67bff71999-11-15Jonas Wallden  if (args->wi && (req_width < args->wi)) req_width = args->wi;
fde9082000-02-08Per Hedbor  int icn_x, txt_x;
944d9e2000-02-08Per Hedbor 
fde9082000-02-08Per Hedbor  switch (lower_case(args->al)) {
67bff71999-11-15Jonas Wallden  case "left": // Allow icon alignment: left, right
fde9082000-02-08Per Hedbor  switch (lower_case(args->ica)) { case "left": icn_x = left;
3ef6452000-02-08Jonas Wallden  txt_x = icn_x + i_width + i_spc;
fde9082000-02-08Per Hedbor  break; default: case "right": txt_x = left; icn_x = req_width - right - i_width; break;
67bff71999-11-15Jonas Wallden  } break; default: case "center": case "middle": // Allow icon alignment: left, center, center_before, center_after, right
fde9082000-02-08Per Hedbor  switch (lower_case(args->ica)) { case "left": icn_x = left;
3ef6452000-02-08Jonas Wallden  txt_x = (req_width - right - left - i_width - i_spc - t_width) / 2; txt_x += icn_x + i_width + i_spc;
fde9082000-02-08Per Hedbor  break; default: case "center": case "center_before":
3ef6452000-02-08Jonas Wallden  icn_x = (req_width - i_width - i_spc - t_width) / 2; txt_x = icn_x + i_width + i_spc;
fde9082000-02-08Per Hedbor  break; case "center_after":
3ef6452000-02-08Jonas Wallden  txt_x = (req_width - i_width - i_spc - t_width) / 2; icn_x = txt_x + t_width + i_spc;
fde9082000-02-08Per Hedbor  break; case "right": icn_x = req_width - right - i_width;
3ef6452000-02-08Jonas Wallden  txt_x = left + (icn_x - i_spc - t_width) / 2;
fde9082000-02-08Per Hedbor  break;
67bff71999-11-15Jonas Wallden  } break; case "right": // Allow icon alignment: left, right
fde9082000-02-08Per Hedbor  switch (lower_case(args->ica)) { default: case "left": icn_x = left; txt_x = req_width - right - t_width; break; case "right": icn_x = req_width - right - i_width;
3ef6452000-02-08Jonas Wallden  txt_x = icn_x - i_spc - t_width;
fde9082000-02-08Per Hedbor  break;
67bff71999-11-15Jonas Wallden  } break; }
f6ea612000-02-07Per Hedbor 
5321c02000-02-08Per Hedbor  if( args->extra_frame_layers ) {
8a98622000-04-04Per Hedbor  array l = ({ });
5321c02000-02-08Per Hedbor  foreach( args->extra_frame_layers/",", string q ) l += ({ ll[q] }); l-=({ 0 });
8a98622000-04-04Per Hedbor  if( sizeof( l ) ) frame = Image.lay( l+({frame}) );
5321c02000-02-08Per Hedbor  }
f6ea612000-02-07Per Hedbor 
5321c02000-02-08Per Hedbor  if( args->extra_mask_layers ) { array l = ({ }); foreach( args->extra_mask_layers/",", string q ) l += ({ ll[q] }); l-=({ 0 }); if( sizeof( l ) )
fff48a2000-02-21Per Hedbor  { if( mask ) l = ({ mask })+l;
5321c02000-02-08Per Hedbor  mask = Image.lay( l );
fff48a2000-02-21Per Hedbor  }
5321c02000-02-08Per Hedbor  } right = frame->xsize()-right; frame = stretch_layer( frame, left, right, req_width ); if (mask != frame) mask = stretch_layer( mask, left, right, req_width );
e0fda72000-04-04Marcus Comstedt  array(Image.Layer) button_layers = ({ Image.Layer( Image.Image(req_width, frame->ysize(), args->bg),
8a98622000-04-04Per Hedbor  mask->alpha()->scale(req_width,frame->ysize())),
e0fda72000-04-04Marcus Comstedt  });
8a98622000-04-04Per Hedbor  if( args->extra_background_layers || background)
fde9082000-02-08Per Hedbor  {
8a98622000-04-04Per Hedbor  array l = ({ background }); foreach( (args->extra_background_layers||"")/","-({""}), string q ) l += ({ ll[q] }); l-=({ 0 }); foreach( l, object ll ) { if( args->dim ) ll->set_alpha_value( 0.3 ); button_layers += ({ stretch_layer( ll, left, right, req_width ) }); }
fde9082000-02-08Per Hedbor  }
12493c2000-02-22Per Hedbor 
8a98622000-04-04Per Hedbor  button_layers += ({ frame });
12493c2000-02-22Per Hedbor  frame->set_mode( "value" ); if( args->dim ) {
1ac32d2000-02-10Jonas Wallden  // Adjust dimmed border intensity to the background int bg_value = Image.Color(@args->bg)->hsv()[2]; int dim_high, dim_low; if (bg_value < 128) { dim_low = max(bg_value - 64, 0); dim_high = dim_low + 128; } else { dim_high = min(bg_value + 64, 255); dim_low = dim_high - 128; }
12493c2000-02-22Per Hedbor  frame->set_image(frame->image()-> modify_by_intensity( 1, 1, 1, ({ dim_low, dim_low, dim_low }), ({ dim_high, dim_high, dim_high })), frame->alpha());
1ac32d2000-02-10Jonas Wallden  }
1a54422000-02-21Per Hedbor 
fde9082000-02-08Per Hedbor  // Draw icon. if (icon)
1a54422000-02-21Per Hedbor  button_layers += ({ Image.Layer( ([
12493c2000-02-22Per Hedbor  "alpha_value":(args->dim ? 0.3 : 1.0),
1a54422000-02-21Per Hedbor  "image":icon->img,
12493c2000-02-22Per Hedbor  "alpha":icon->alpha,
1a54422000-02-21Per Hedbor  "xoffset":icn_x,
12493c2000-02-22Per Hedbor  "yoffset":(frame->ysize()-icon->img->ysize())/2,
1a54422000-02-21Per Hedbor  ]) )});
f6ea612000-02-07Per Hedbor 
67bff71999-11-15Jonas Wallden  // Draw text
3c24b62000-01-19Fredrik Noring  if(text_img)
1a54422000-02-21Per Hedbor  button_layers += ({ Image.Layer(([
12493c2000-02-22Per Hedbor  "alpha_value":(args->dim ? 0.5 : 1.0),
78bca32000-02-28Jonas Wallden  "image":text_img->color(0,0,0)->invert()->color(@args->txt),
735b932000-02-24Per Hedbor  "alpha":text_img,
1a54422000-02-21Per Hedbor  "xoffset":txt_x, "yoffset":top, ])) });
7169752000-02-02Per Hedbor 
fff48a2000-02-21Per Hedbor  // 'plain' extra layers are added on top of everything else
5321c02000-02-08Per Hedbor  if( args->extra_layers ) {
1a54422000-02-21Per Hedbor  array q = map(args->extra_layers/",", lambda(string q) { return ll[q]; } )-({0});
8a98622000-04-04Per Hedbor  foreach( q, object ll ) { if( args->dim ) ll->set_alpha_value( 0.3 ); button_layers += ({stretch_layer(ll,left,right,req_width)}); }
5321c02000-02-08Per Hedbor  }
1a54422000-02-21Per Hedbor  button_layers -= ({ 0 });
fff48a2000-02-21Per Hedbor  // left layers are added to the left of the image, and the mask is // extended using their mask. There is no corresponding 'mask' layers // for these, but that is not a problem most of the time. if( args->extra_left_layers ) { array l = ({ }); foreach( args->extra_left_layers/",", string q ) l += ({ ll[q] }); l-=({ 0 }); if( sizeof( l ) ) { object q = Image.lay( l );
1a54422000-02-21Per Hedbor  foreach( button_layers, object b ) { int x = b->xoffset(); int y = b->yoffset(); b->set_offset( x+q->xsize(), y ); }
185bd42000-02-21Per Hedbor  q->set_offset( 0, 0 );
1a54422000-02-21Per Hedbor  button_layers += ({ q });
fff48a2000-02-21Per Hedbor  } } // right layers are added to the right of the image, and the mask is // extended using their mask. There is no corresponding 'mask' layers // for these, but that is not a problem most of the time. if( args->extra_right_layers ) { array l = ({ }); foreach( args->extra_right_layers/",", string q ) l += ({ ll[q] }); l-=({ 0 }); if( sizeof( l ) ) { object q = Image.lay( l );
a76b0a2000-02-22Per Hedbor  q->set_offset( button_layers[0]->xsize()+ button_layers[0]->xoffset(),0);
1a54422000-02-21Per Hedbor  button_layers += ({ q });
fff48a2000-02-21Per Hedbor  } }
5321c02000-02-08Per Hedbor 
1a54422000-02-21Per Hedbor  button_layers = ({Image.lay( button_layers )});
185bd42000-02-21Per Hedbor  // fix transparency (somewhat) if( !equal( args->pagebg, args->bg ) )
8a98622000-04-04Per Hedbor  return button_layers + ({ Image.Layer(([ "fill":args->pagebg, "alpha":button_layers[0]->alpha()->invert(), ])) });
1a54422000-02-21Per Hedbor  return button_layers;
67bff71999-11-15Jonas Wallden } mapping find_internal(string f, RequestID id) { return button_cache->http_file_answer(f, id); }
c421c62000-03-14Martin Nilsson class ButtonFrame { inherit RXML.Frame;
f29b142000-03-24Per Hedbor  array mk_url(RequestID id) {
c421c62000-03-14Martin Nilsson  string fi = (args["frame-image"]||id->misc->defines["gbutton-frame-image"]); if( fi )
bf956c2000-05-01Martin Nilsson  fi = Roxen.fix_relative( fi, id );
c421c62000-03-14Martin Nilsson  mapping new_args = ([ "pagebg" :parse_color(args->pagebgcolor || id->misc->defines->theme_bgcolor || id->misc->defines->bgcolor || args->bgcolor || "#eeeeee"), // _page_ background color "bg" : parse_color(args->bgcolor || id->misc->defines->theme_bgcolor || id->misc->defines->bgcolor || "#eeeeee"), // Background color "txt" : parse_color(args->textcolor || id->misc->defines->theme_bgcolor || id->misc->defines->fgcolor || "#000000"), // Text color "cnd" : (args->condensed || // Condensed text (lower_case(args->textstyle || "") == "condensed")), "wi" : (int) args->width, // Min button width "al" : args->align || "left", // Text alignment "dim" : (args->dim || // Button dimming (< "dim", "disabled" >)[lower_case(args->state || "")]),
bf956c2000-05-01Martin Nilsson  "icn" : args->icon_src && Roxen.fix_relative(args->icon_src, id), // Icon URL
c421c62000-03-14Martin Nilsson  "icd" : args->icon_data, // Inline icon data "ica" : args->align_icon || "left", // Icon alignment "font": (args->font||id->misc->defines->font|| roxen->query("default_font")), "border_image":fi, "extra_layers":args["extra-layers"], "extra_left_layers":args["extra-left-layers"], "extra_right_layers":args["extra-right-layers"], "extra_background_layers":args["extra-background-layers"], "extra_mask_layers":args["extra-mask-layers"], "extra_frame_layers":args["extra-frame-layers"], ]); new_args->quant = args->quant || 128; foreach(glob("*-*", indices(args)), string n) new_args[n] = args[n]; string img_src = query_internal_location() + button_cache->store( ({ new_args, content }), id); return ({ img_src, new_args }); } } class TagGButtonURL { inherit RXML.Tag; constant name = "gbutton-url"; RXML.Type content_type = RXML.t_text(RXML.PXml); class Frame { inherit ButtonFrame; array do_return(RequestID id) { result=mk_url(id)[0]; return 0; }
67bff71999-11-15Jonas Wallden  }
c421c62000-03-14Martin Nilsson }
5dac1c2000-01-10Martin Nilsson 
c421c62000-03-14Martin Nilsson class TagGButtom { inherit RXML.Tag; constant name = "gbutton"; RXML.Type content_type = RXML.t_text(RXML.PXml); class Frame { inherit ButtonFrame; array do_return(RequestID id) { [string img_src, mapping new_args]=mk_url(id); mapping img_attrs = ([ "src" : img_src, "alt" : args->alt || content, "border" : args->border, "hspace" : args->hspace, "vspace" : args->vspace ]);
5b37862000-04-04Per Hedbor  if( args->align ) img_attrs->align = args->align;
c421c62000-03-14Martin Nilsson  if (mapping size = button_cache->metadata(new_args, id, 1)) { // Image in cache (1 above prevents generation on-the-fly, i.e. // first image will lack sizes). img_attrs->width = size->xsize; img_attrs->height = size->ysize; }
bf956c2000-05-01Martin Nilsson  result = Roxen.make_tag("img", img_attrs);
dbc2722000-03-24Johan Sundström 
c421c62000-03-14Martin Nilsson  // Make button clickable if not dimmed
dbc2722000-03-24Johan Sundström  if(args->href && !new_args->dim) {
c421c62000-03-14Martin Nilsson  mapping a_attrs = ([ "href" : args->href ]);
dbc2722000-03-24Johan Sundström  foreach(indices(args), string arg) if(has_value("target/onmousedown/onmouseup/onclick/ondblclick/onmouseout/" "onmouseover/onkeypress/onkeyup/onkeydown"/"/", lower_case(arg))) a_attrs[arg] = args[arg];
bf956c2000-05-01Martin Nilsson  result = Roxen.make_container("a", a_attrs, result);
dbc2722000-03-24Johan Sundström  }
c421c62000-03-14Martin Nilsson  return 0; } }
67bff71999-11-15Jonas Wallden }