git.gag.com Git - debian/gnuradio/blob - grc/gui/Utils.py

   1 """
   2 Copyright 2008, 2009 Free Software Foundation, Inc.
   3 This file is part of GNU Radio
   4
   5 GNU Radio Companion is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU General Public License
   7 as published by the Free Software Foundation; either version 2
   8 of the License, or (at your option) any later version.
   9
  10 GNU Radio Companion is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18 """
  19
  20 from Constants import POSSIBLE_ROTATIONS
  21 from Cheetah.Template import Template
  22
  23 def get_rotated_coordinate(coor, rotation):
  24         """
  25         Rotate the coordinate by the given rotation.
  26         @param coor the coordinate x, y tuple
  27         @param rotation the angle in degrees
  28         @return the rotated coordinates
  29         """
  30         #handles negative angles
  31         rotation = (rotation + 360)%360
  32         assert rotation in POSSIBLE_ROTATIONS
  33         #determine the number of degrees to rotate
  34         cos_r, sin_r = {
  35                 0: (1, 0),
  36                 90: (0, 1),
  37                 180: (-1, 0),
  38                 270: (0, -1),
  39         }[rotation]
  40         x, y = coor
  41         return (x*cos_r + y*sin_r, -x*sin_r + y*cos_r)
  42
  43 def get_angle_from_coordinates((x1,y1), (x2,y2)):
  44         """
  45         Given two points, calculate the vector direction from point1 to point2, directions are multiples of 90 degrees.
  46         @param (x1,y1) the coordinate of point 1
  47         @param (x2,y2) the coordinate of point 2
  48         @return the direction in degrees
  49         """
  50         if y1 == y2:#0 or 180
  51                 if x2 > x1: return 0
  52                 else: return 180
  53         else:#90 or 270
  54                 if y2 > y1: return 270
  55                 else: return 90
  56
  57 def xml_encode(string):
  58         """
  59         Encode a string into an xml safe string by replacing special characters.
  60         Needed for gtk pango markup in labels.
  61         @param string the input string
  62         @return output string with safe characters
  63         """
  64         string = str(string)
  65         for char, safe in (
  66                         ('&', '&amp;'),
  67                         ('<', '&lt;'),
  68                         ('>', '&gt;'),
  69                         ('"', '&quot;'),
  70                         ("'", '&apos;'),
  71         ): string = string.replace(char, safe)
  72         return string
  73
  74 def parse_template(tmpl_str, **kwargs):
  75         """
  76         Parse the template string with the given args.
  77         Pass in the xml encode method for pango escape chars.
  78         @param tmpl_str the template as a string
  79         @return a string of the parsed template
  80         """
  81         kwargs['encode'] = xml_encode
  82         return str(Template(tmpl_str, kwargs))