pyx/unit.py

   1 #!/usr/bin/env python
   2 # -*- coding: ISO-8859-1 -*-
   3 #
   4 #
   5 # Copyright (C) 2002-2004 Jörg Lehmann <joergl@users.sourceforge.net>
   6 # Copyright (C) 2002-2004 André Wobst <wobsta@users.sourceforge.net>
   7 #
   8 # This file is part of PyX (http://pyx.sourceforge.net/).
   9 #
  10 # PyX is free software; you can redistribute it and/or modify
  11 # it under the terms of the GNU General Public License as published by
  12 # the Free Software Foundation; either version 2 of the License, or
  13 # (at your option) any later version.
  14 #
  15 # PyX is distributed in the hope that it will be useful,
  16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 # GNU General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU General Public License
  21 # along with PyX; if not, write to the Free Software
  22 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23
  24 import types
  25 import re
  26 import helper
  27
  28 scale = { 't':1, 'u':1, 'v':1, 'w':1, 'x':1 }
  29
  30 _default_unit = "cm"
  31
  32 unit_pattern = re.compile(r"""^\s*([+-]?\d*((\d\.?)|(\.?\d))\d*(E[+-]?\d+)?)
  33                               (\s+([t-x]))?
  34                               (\s+(([a-z][a-z]+)|[^t-x]))?\s*$""",
  35                           re.IGNORECASE | re.VERBOSE)
  36
  37
  38 _m = {
  39       'm' :   1,
  40       'cm':   0.01,
  41       'mm':   0.001,
  42       'inch': 0.01*2.54,
  43       'pt':   0.01*2.54/72,
  44     }
  45
  46 def set(uscale=None, vscale=None, wscale=None, xscale=None, defaultunit=None):
  47     if uscale is not None:
  48         scale['u'] = uscale
  49     if vscale is not None:
  50         scale['v'] = vscale
  51     if wscale is not None:
  52         scale['w'] = wscale
  53     if xscale is not None:
  54         scale['x'] = xscale
  55     if defaultunit is not None:
  56         global _default_unit
  57         _default_unit = defaultunit
  58
  59
  60 def _convert_to(l, dest_unit="m"):
  61     if type(l) in (types.IntType, types.LongType, types.FloatType):
  62         return l*_m[_default_unit]*scale['u']/_m[dest_unit]
  63     elif not isinstance(l, length):
  64         l=length(l)       # convert to length instance if necessary
  65
  66     return ( l.length['t']            +
  67              l.length['u']*scale['u'] +
  68              l.length['v']*scale['v'] +
  69              l.length['w']*scale['w'] +
  70              l.length['x']*scale['x'] ) / _m[dest_unit]
  71
  72 def tom(l):
  73     return _convert_to(l, "m")
  74
  75 def tocm(l):
  76     return _convert_to(l, "cm")
  77
  78 def tomm(l):
  79     return _convert_to(l, "mm")
  80
  81 def toinch(l):
  82     return _convert_to(l, "inch")
  83
  84 def topt(l):
  85     return _convert_to(l, "pt")
  86
  87 ################################################################################
  88 # class for generic length
  89 ################################################################################
  90
  91 class length:
  92     """ general lengths
  93
  94     Lengths can either be a initialized with a number or a string:
  95
  96      - a length specified as a number corresponds to the default values of
  97        unit_type and unit_name
  98      - a string has to consist of a maximum of three parts:
  99        -quantifier: integer/float value
 100        -unit_type:  "t", "u", "v", "w", or "x".
 101                     Optional, defaults to "u"
 102        -unit_name:  "m", "cm", "mm", "inch", "pt".
 103                     Optional, defaults to _default_unit
 104
 105     Internally all length are stored in units of m as a quadruple of the four
 106     unit_types.
 107
 108     """
 109
 110     def __init__(self, l=1, default_type="u", dunit=None):
 111         self.length = { 't': 0 , 'u': 0, 'v': 0, 'w': 0, 'x': 0 }
 112
 113         if isinstance(l, length):
 114             self.length = l.length
 115         elif helper.isnumber(l):
 116             self.length[default_type] = l*_m[dunit or _default_unit]
 117         elif helper.isstring(l):
 118             unit_match = re.match(unit_pattern, l)
 119             if unit_match is None:
 120                 raise ValueError("expecting number or string of the form 'number [u|v|w|x] unit'")
 121             else:
 122                 self.prefactor = float(unit_match.group(1))
 123                 self.unit_type = unit_match.group(7) or default_type
 124                 self.unit_name = unit_match.group(9) or dunit or _default_unit
 125
 126                 self.length[self.unit_type] = self.prefactor*_m[self.unit_name]
 127         else:
 128             raise NotImplementedError("cannot convert given argument to length type")
 129
 130     def __cmp__(self, other):
 131         return cmp(tom(self), tom(other))
 132
 133     def __mul__(self, factor):
 134         newlength = self.__class__()
 135         for unit_type in newlength.length.keys():
 136            newlength.length[unit_type] = self.length[unit_type]*factor
 137         return newlength
 138
 139     __rmul__=__mul__
 140
 141     def __div__(self, factor):
 142         newlength = self.__class__()
 143         for unit_type in newlength.length.keys():
 144            newlength.length[unit_type] = self.length[unit_type]/factor
 145         return newlength
 146
 147     def __add__(self, l):
 148         # convert to length if necessary
 149         ll = length(l)
 150         newlength = self.__class__()
 151         for unit_type in newlength.length.keys():
 152            newlength.length[unit_type] = self.length[unit_type] + ll.length[unit_type]
 153         return newlength
 154
 155     __radd__=__add__
 156
 157     def __sub__(self, l):
 158         # convert to length if necessary
 159         ll = length(l)
 160         newlength = self.__class__()
 161         for unit_type in newlength.length.keys():
 162            newlength.length[unit_type] = self.length[unit_type] - ll.length[unit_type]
 163         return newlength
 164
 165     def __rsub__(self, l):
 166         # convert to length if necessary
 167         ll = length(l)
 168         newlength = self.__class__()
 169         for unit_type in newlength.length.keys():
 170            newlength.length[unit_type] = ll.length[unit_type] - self.length[unit_type]
 171         return newlength
 172
 173     def __neg__(self):
 174         newlength = self.__class__()
 175         for unit_type in newlength.length.keys():
 176            newlength.length[unit_type] = -self.length[unit_type]
 177         return newlength
 178
 179     def __str__(self):
 180         return "(%(t)f t + %(u)f u + %(v)f v + %(w)f w + %(x)f x) m" % self.length
 181
 182
 183 ################################################################################
 184 # class for more specialized lengths
 185 ################################################################################
 186
 187 # lengths with user units as default
 188
 189 class u_pt(length):
 190     def __init__(self, l=1, default_type="u"):
 191        length.__init__(self, l, default_type=default_type, dunit="pt")
 192
 193
 194 class u_m(length):
 195     def __init__(self, l=1, default_type="u"):
 196        length.__init__(self, l, default_type=default_type, dunit="m")
 197
 198
 199 class u_mm(length):
 200     def __init__(self, l=1, default_type="u"):
 201        length.__init__(self, l, default_type=default_type, dunit="mm")
 202
 203
 204 class u_cm(length):
 205     def __init__(self, l=1, default_type="u"):
 206        length.__init__(self, l, default_type=default_type, dunit="cm")
 207
 208
 209 class u_inch(length):
 210     def __init__(self, l=1, default_type="u"):
 211        length.__init__(self, l, default_type=default_type, dunit="inch")
 212
 213 # without further specification, length are user length. Hence we
 214 # define the following aliases
 215
 216 pt = u_pt
 217 m = u_m
 218 cm = u_cm
 219 mm = u_mm
 220 inch = u_inch
 221
 222 # true lengths
 223
 224 class t_pt(length):
 225     def __init__(self, l=1):
 226        length.__init__(self, l, default_type="t", dunit="pt")
 227
 228
 229 class t_m(length):
 230     def __init__(self, l=1):
 231        length.__init__(self, l, default_type="t", dunit="m")
 232
 233
 234 class t_cm(length):
 235     def __init__(self, l=1):
 236        length.__init__(self, l, default_type="t", dunit="cm")
 237
 238
 239 class t_mm(length):
 240     def __init__(self, l=1):
 241        length.__init__(self, l, default_type="t", dunit="mm")
 242
 243
 244 class t_inch(length):
 245     def __init__(self, l=1):
 246        length.__init__(self, l, default_type="t", dunit="inch")
 247
 248 # visual lengths
 249
 250 class v_pt(length):
 251     def __init__(self, l=1):
 252        length.__init__(self, l, default_type="v", dunit="pt")
 253
 254
 255 class v_m(length):
 256     def __init__(self, l=1):
 257        length.__init__(self, l, default_type="v", dunit="m")
 258
 259
 260 class v_cm(length):
 261     def __init__(self, l=1):
 262        length.__init__(self, l, default_type="v", dunit="cm")
 263
 264
 265 class v_mm(length):
 266     def __init__(self, l=1):
 267        length.__init__(self, l, default_type="v", dunit="mm")
 268
 269
 270 class v_inch(length):
 271     def __init__(self, l=1):
 272        length.__init__(self, l, default_type="v", dunit="inch")
 273
 274 # width lengths
 275
 276 class w_pt(length):
 277     def __init__(self, l=1):
 278        length.__init__(self, l, default_type="w", dunit="pt")
 279
 280
 281 class w_m(length):
 282     def __init__(self, l=1):
 283        length.__init__(self, l, default_type="w", dunit="m")
 284
 285
 286 class w_cm(length):
 287     def __init__(self, l=1):
 288        length.__init__(self, l, default_type="w", dunit="cm")
 289
 290
 291 class w_mm(length):
 292     def __init__(self, l=1):
 293        length.__init__(self, l, default_type="w", dunit="mm")
 294
 295
 296 class w_inch(length):
 297     def __init__(self, l=1):
 298        length.__init__(self, l, default_type="w", dunit="inch")
 299
 300 # tex lengths
 301
 302 class x_pt(length):
 303     def __init__(self, l=1):
 304        length.__init__(self, l, default_type="x", dunit="pt")
 305
 306
 307 class x_m(length):
 308     def __init__(self, l=1):
 309        length.__init__(self, l, default_type="x", dunit="m")
 310
 311
 312 class x_cm(length):
 313     def __init__(self, l=1):
 314        length.__init__(self, l, default_type="x", dunit="cm")
 315
 316
 317 class x_mm(length):
 318     def __init__(self, l=1):
 319        length.__init__(self, l, default_type="x", dunit="mm")
 320
 321
 322 class x_inch(length):
 323     def __init__(self, l=1):
 324        length.__init__(self, l, default_type="x", dunit="inch")