lib/Util.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 // Util.hh for Blackbox - an X11 Window manager
   3 // Copyright (c) 2001 - 2005 Sean 'Shaleh' Perry <shaleh@debian.org>
   4 // Copyright (c) 1997 - 2000, 2002 - 2005
   5 //         Bradley T Hughes <bhughes at trolltech.com>
   6 //
   7 // Permission is hereby granted, free of charge, to any person obtaining a
   8 // copy of this software and associated documentation files (the "Software"),
   9 // to deal in the Software without restriction, including without limitation
  10 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11 // and/or sell copies of the Software, and to permit persons to whom the
  12 // Software is furnished to do so, subject to the following conditions:
  13 //
  14 // The above copyright notice and this permission notice shall be included in
  15 // all copies or substantial portions of the Software.
  16 //
  17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23 // DEALINGS IN THE SOFTWARE.
  24
  25 #ifndef __Util_hh
  26 #define __Util_hh
  27
  28 #include <limits.h>
  29 #include <string>
  30
  31 // forward declarations of X11 types
  32 typedef struct _XDisplay Display;
  33 typedef union _XEvent XEvent;
  34 typedef struct _XGC *GC;
  35 typedef struct _XOC *XFontSet;
  36 typedef struct _XftFont XftFont;
  37 typedef unsigned long Time;
  38 typedef unsigned long XID;
  39 typedef XID Atom;
  40 typedef XID Colormap;
  41 typedef XID Cursor;
  42 typedef XID Drawable;
  43 typedef XID Pixmap;
  44 typedef XID Window;
  45
  46 namespace bt {
  47
  48   // XXX perhaps we could just call this SENTINEL?
  49   const unsigned int BSENTINEL = UINT_MAX;
  50
  51   class NoCopy {
  52   protected:
  53     inline NoCopy(void)
  54     { }
  55   private:
  56     NoCopy(const NoCopy&);
  57     NoCopy& operator=(const NoCopy&);
  58   };
  59
  60   class PointerAssassin {
  61   public:
  62     template<typename T>
  63     inline void operator()(const T ptr) const
  64     { delete ptr; }
  65   };
  66
  67   inline bool within(int x, int y, int width, int height)
  68   { return ((x >= 0 && x <= width) && (y >= 0 && y <= height)); }
  69
  70   void bexec(const std::string& command, const std::string& displaystring);
  71
  72   std::string basename(const std::string& path);
  73   std::string dirname(const std::string& path);
  74
  75   // equivalent to the shell command 'mkdir -m mode -p path'
  76   bool mkdirhier(const std::string &path, int mode = 0777);
  77
  78   std::string expandTilde(const std::string& s);
  79
  80   std::string itostring(unsigned long i);
  81   std::string itostring(long i);
  82
  83   inline std::string itostring(unsigned int i)
  84   { return itostring(static_cast<unsigned long>(i)); }
  85
  86   inline std::string itostring(int i)
  87   { return itostring(static_cast<long>(i)); }
  88
  89   inline std::string itostring(unsigned short i)
  90   { return itostring(static_cast<unsigned long>(i)); }
  91
  92   inline std::string itostring(short i)
  93   { return itostring(static_cast<long>(i)); }
  94
  95   std::string tolower(const std::string &string);
  96
  97 #ifdef _XUTIL_H_
  98   std::string textPropertyToString(::Display *display,
  99                                    ::XTextProperty& text_prop);
 100 #endif
 101
 102 } // namespace bt
 103
 104 #endif // __Util_hh