mod_sp/main.c

   1 /*
   2  * ion/mod_sp/main.c
   3  *
   4  * Copyright (c) Tuomo Valkonen 2004-2009.
   5  *
   6  * See the included file LICENSE for details.
   7  */
   8
   9 #include <string.h>
  10
  11 #include <libtu/map.h>
  12 #include <libtu/minmax.h>
  13 #include <libextl/readconfig.h>
  14 #include <libmainloop/hooks.h>
  15
  16 #include <ioncore/saveload.h>
  17 #include <ioncore/screen.h>
  18 #include <ioncore/mplex.h>
  19 #include <ioncore/stacking.h>
  20 #include <ioncore/ioncore.h>
  21 #include <ioncore/global.h>
  22 #include <ioncore/framep.h>
  23 #include <ioncore/frame.h>
  24 #include <ioncore/names.h>
  25 #include <ioncore/group.h>
  26 #include <ioncore/group-ws.h>
  27
  28 #include "main.h"
  29 #include "exports.h"
  30
  31
  32 /*{{{ Module information */
  33
  34 #include "../version.h"
  35
  36 char mod_sp_ion_api_version[]=NOTION_API_VERSION;
  37
  38
  39 /*}}}*/
  40
  41
  42 /*{{{ Bindmaps, config, etc. */
  43
  44
  45 #define SP_NAME  "*scratchpad*"
  46 #define SPWS_NAME  "*scratchws*"
  47
  48
  49 /*}}}*/
  50
  51
  52 /*{{{ Exports */
  53
  54
  55 static WRegion *create_frame_scratchpad(WWindow *parent, const WFitParams *fp,
  56                                         void *unused)
  57 {
  58     return (WRegion*)create_frame(parent, fp, FRAME_MODE_UNKNOWN, "Scratchpad Frame");
  59 }
  60
  61
  62 static WRegion *create_scratchws(WWindow *parent, const WFitParams *fp,
  63                                  void *unused)
  64 {
  65     WRegion *reg;
  66     WRegionAttachData data;
  67     WGroupAttachParams par=GROUPATTACHPARAMS_INIT;
  68     WGroupWS *ws;
  69
  70     ws=create_groupws(parent, fp);
  71
  72     if(ws==NULL)
  73         return NULL;
  74
  75     region_set_name((WRegion*)ws, SPWS_NAME);
  76
  77     data.type=REGION_ATTACH_NEW;
  78     data.u.n.fn=create_frame_scratchpad;
  79     data.u.n.param=NULL;
  80
  81     par.szplcy_set=TRUE;
  82     par.szplcy=SIZEPOLICY_FREE_GLUE;
  83
  84     par.geom_set=TRUE;
  85     par.geom.w=minof(fp->g.w, CF_SCRATCHPAD_DEFAULT_W);
  86     par.geom.h=minof(fp->g.h, CF_SCRATCHPAD_DEFAULT_H);
  87     par.geom.x=(fp->g.w-par.geom.w)/2;
  88     par.geom.y=(fp->g.h-par.geom.h)/2;
  89
  90     par.level_set=TRUE;
  91     par.level=STACKING_LEVEL_MODAL1+1;
  92
  93     par.bottom=TRUE;
  94
  95     reg=group_do_attach(&ws->grp, &par, &data);
  96
  97     if(reg==NULL){
  98         destroy_obj((Obj*)ws);
  99         return NULL;
 100     }
 101
 102     region_set_name((WRegion*)reg, SP_NAME);
 103
 104     return (WRegion*)ws;
 105 }
 106
 107
 108 static WRegion *create(WMPlex *mplex, int flags)
 109 {
 110     WRegion *sp;
 111     WMPlexAttachParams par=MPLEXATTACHPARAMS_INIT;
 112
 113     par.flags=(flags
 114                |MPLEX_ATTACH_UNNUMBERED
 115                |MPLEX_ATTACH_SIZEPOLICY
 116                |MPLEX_ATTACH_PSEUDOMODAL);
 117     par.szplcy=SIZEPOLICY_FULL_EXACT;
 118
 119     sp=mplex_do_attach_new(mplex, &par,
 120                            create_scratchws,
 121                            NULL);
 122
 123     if(sp==NULL)
 124         warn(TR("Unable to create scratchpad."));
 125
 126     return sp;
 127 }
 128
 129
 130 static bool is_scratchpad(WRegion *reg)
 131 {
 132     char *nm=reg->ni.name;
 133     int inst_off=reg->ni.inst_off;
 134
 135     if(nm==NULL)
 136         return FALSE;
 137
 138     return (inst_off<0
 139             ? (strcmp(nm, SP_NAME)==0 ||
 140                strcmp(nm, SPWS_NAME)==0)
 141             : (strncmp(nm, SP_NAME, inst_off)==0 ||
 142                strncmp(nm, SPWS_NAME, inst_off)==0));
 143 }
 144
 145 /*EXTL_DOC
 146  * Is \var{reg} a scratchpad?
 147  */
 148 EXTL_SAFE
 149 EXTL_EXPORT
 150 bool mod_sp_is_scratchpad(WRegion *reg)
 151 {
 152     return is_scratchpad(reg);
 153 }
 154
 155 /*EXTL_DOC
 156  * Attempt to create a scratchpad on \var{scr}.
 157  */
 158 EXTL_EXPORT
 159 bool mod_sp_create_scratchpad(WScreen *scr)
 160 {
 161     WMPlexIterTmp tmp;
 162     WRegion *reg;
 163
 164     FOR_ALL_MANAGED_BY_MPLEX((WMPlex*)scr, reg, tmp){
 165         if(is_scratchpad(reg))
 166             return TRUE;
 167     }
 168
 169     return create(&scr->mplex, MPLEX_ATTACH_HIDDEN)!=NULL;
 170 }
 171
 172 /*EXTL_DOC
 173  * Change displayed status of some scratchpad on \var{mplex} if one is
 174  * found. The parameter \var{how} is one of
 175  * \codestr{set}, \codestr{unset}, or \codestr{toggle}.
 176  * The resulting status is returned.
 177  */
 178 EXTL_EXPORT
 179 bool mod_sp_set_shown_on(WMPlex *mplex, const char *how)
 180 {
 181     int setpar=libtu_setparam_invert(libtu_string_to_setparam(how));
 182     WMPlexIterTmp tmp;
 183     WRegion *reg;
 184     bool found=FALSE, res=FALSE;
 185
 186     FOR_ALL_MANAGED_BY_MPLEX(mplex, reg, tmp){
 187         if(is_scratchpad(reg)){
 188             res=!mplex_set_hidden(mplex, reg, setpar);
 189             found=TRUE;
 190         }
 191     }
 192
 193     if(!found){
 194         int sp=libtu_string_to_setparam(how);
 195         if(sp==SETPARAM_SET || sp==SETPARAM_TOGGLE)
 196             found=(create(mplex, 0)!=NULL);
 197             res=found;
 198     }
 199
 200     return res;
 201 }
 202
 203
 204 /*EXTL_DOC
 205  * Toggle displayed status of \var{sp}.
 206  * The parameter \var{how} is one of
 207  * \codestr{set}, \codestr{unset}, or \codestr{toggle}.
 208  * The resulting status is returned.
 209  */
 210 EXTL_EXPORT
 211 bool mod_sp_set_shown(WFrame *sp, const char *how)
 212 {
 213     if(sp!=NULL){
 214         int setpar=libtu_setparam_invert(libtu_string_to_setparam(how));
 215         WMPlex *mplex=OBJ_CAST(REGION_MANAGER(sp), WMPlex);
 216         if(mplex!=NULL)
 217             return mplex_set_hidden(mplex, (WRegion*)sp, setpar);
 218     }
 219
 220     return FALSE;
 221 }
 222
 223
 224 /*}}}*/
 225
 226
 227 /*{{{ Init & deinit */
 228
 229
 230 void mod_sp_deinit()
 231 {
 232     mod_sp_unregister_exports();
 233 }
 234
 235
 236 static void check_and_create()
 237 {
 238     WMPlexIterTmp tmp;
 239     WScreen *scr;
 240     WRegion *reg;
 241
 242     /* No longer needed, free the memory the list uses. */
 243     hook_remove(ioncore_post_layout_setup_hook, check_and_create);
 244
 245     FOR_ALL_SCREENS(scr){
 246         FOR_ALL_MANAGED_BY_MPLEX((WMPlex*)scr, reg, tmp){
 247             if(is_scratchpad(reg))
 248                 return;
 249         }
 250
 251         create(&scr->mplex, MPLEX_ATTACH_HIDDEN);
 252     }
 253 }
 254
 255
 256 bool mod_sp_init()
 257 {
 258     if(!mod_sp_register_exports())
 259         return FALSE;
 260
 261     extl_read_config("cfg_sp", NULL, FALSE);
 262
 263     if(ioncore_g.opmode==IONCORE_OPMODE_INIT){
 264         hook_add(ioncore_post_layout_setup_hook, check_and_create);
 265     }else{
 266         check_and_create();
 267     }
 268
 269     return TRUE;
 270 }
 271
 272
 273 /*}}}*/
 274