prefig 0.4.8__tar.gz → 0.5.1__tar.gz

{prefig-0.4.8 → prefig-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prefig
-Version: 0.4.8
+Version: 0.5.1
 Summary: An authoring system for mathematical diagrams
 Home-page: https://prefigure.org
 License: GPL-3.0-or-later

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/annotations.py

@@ -33,14 +33,20 @@ def annotate(element, diagram, parent = None):
         parent = diagram.get_annotations_root()
 
     if element.get('ref', None) is not None:
-        element.set('id', element.get('ref'))
+        ref = element.get('ref')
+        if not ref.startswith('pf__'):
+            ref = 'pf__' + ref
+        element.set('id', ref)
         element.attrib.pop('ref')
     else:
         log.info(f"An annotation has an empty attribute ref")
     element.attrib.pop('annotate', None)
 
     # let's check to see if this is a reference to an annotation branch
-    annotation = diagram.get_annotation_branch(element.get('id'))
+    id = element.get('id')
+    if not id.startswith('pf__'):
+        id = 'pf__' + id
+    annotation = diagram.get_annotation_branch(id)
     if annotation is not None:
         annotate(annotation, diagram, parent)
         return

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/arrow.py

@@ -22,7 +22,7 @@ def add_tactile_arrowhead_marker(diagram, path, mid=False):
     # get the stroke width from the graphical component
     stroke_width_str = path.get('stroke-width', '1')
     stroke_width = int(stroke_width_str)
-    id = 'arrow-head-'+stroke_width_str
+    id = 'pf__arrow-head-'+stroke_width_str
 
     # if we've seen this already, there's no need to create it again
     if diagram.has_reusable(id):
@@ -180,12 +180,12 @@ def add_arrowhead_marker(diagram,
     # end or in the middle of a path
     id_data = f"_{arrow_width}_{arrow_angles[0]}_{arrow_angles[1]}"
     if not mid:
-        id = 'arrow-head-end-'+stroke_width_str+id_data+'-'+stroke_color
+        id = 'pf__arrow-head-end-'+stroke_width_str+id_data+'-'+stroke_color
         if arrow_width is None:
             arrow_width = 4
         dims = (1, arrow_width)
     else:
-        id = 'arrow-head-mid-'+stroke_width_str+id_data+'-'+stroke_color
+        id = 'pf__arrow-head-mid-'+stroke_width_str+id_data+'-'+stroke_color
         if arrow_width is None:
             arrow_width = 13/3
         dims = (1, arrow_width) #11/3)

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/axes.py

@@ -147,7 +147,7 @@ class Axes():
 
         self.axes = ET.SubElement(parent, 'g',
                                   attrib={
-                                      'id': element.get('id', 'axes'),
+                                      'id': element.get('id', 'pf__axes'),
                                       'stroke': self.stroke,
                                       'stroke-width': self.thickness
                                   }

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/clip.py

@@ -18,7 +18,7 @@ def clip(element, diagram, parent, outline_status):
 
     clip = ET.Element('clipPath')
     clip.append(shape)
-    clip_id = 'clip-'+shape_ref
+    clip_id = shape_ref + '-clip'
     clip.set('id', clip_id)
 
     diagram.add_reusable(clip)

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/diagram.py

@@ -60,7 +60,7 @@ class Diagram:
         self.root = ET.Element("svg", nsmap = nsmap)
 
         self.id_suffix = ['']
-        self.add_id(self.root, diagram_element.get('id', 'diagram'))
+        self.add_id(self.root, diagram_element.get('id', 'pf__figure'))
 
         # prepare the XML tree for annotations, if there are any
         self.annotations_root = None
@@ -79,6 +79,9 @@ class Diagram:
         # a dictionary for holding shapes
         self.shape_dict = {}
 
+        # dictionary for saving graphical data
+        self.saved_data = {}
+
         # each SVG element will have an id, we'll store a count of ids here
         self.ids = {}
 
@@ -192,9 +195,12 @@ class Diagram:
         suffix = ''.join(self.id_suffix)
         if id is None:
             self.ids[element.tag] = self.ids.get(element.tag, -1) + 1
-            return element.tag+'-'+str(self.ids[element.tag])+suffix
+            result_id = element.tag+'-'+str(self.ids[element.tag])+suffix
         else:
-            return id + suffix
+            result_id = id + suffix
+        if result_id.startswith('pf__'):
+            return result_id
+        return 'pf__' + result_id
 
     def append_id_suffix(self, element):
         return self.find_id(element, element.get('id', None))
@@ -235,6 +241,12 @@ class Diagram:
             log.error(f"Unable to apply inverse coordinate transform to {p}")
             return np.array([0,0])
 
+    def save_data(self, element, data):
+        self.saved_data[element] = data
+
+    def retrieve_data(self, element):
+        return self.saved_data.get(element, None)
+
     def begin_figure(self):
         # set up the dimensions of the diagram in SVG coordinates
         dims = self.diagram_element.get('dimensions')
@@ -662,10 +674,16 @@ class Diagram:
 
     def add_annotation_to_branch(self, annotation):
         if len(self.annotation_branch_stack) == 0:
-            self.annotation_branches[annotation.get('id')] = annotation
+            id = annotation.get('id')
+            if not id.startswith('pf__'):
+                id = 'pf__' + id
+            self.annotation_branches[id] = annotation
             return
         self.annotation_branch_stack[-1].append(annotation)
-        annotation.set('id', self.append_id_suffix(annotation))
+        id = self.append_id_suffix(annotation)
+        if not id.startswith('pf__'):
+            id = 'pf__' + id
+        annotation.set('id', id)
 
     def get_annotation_branch(self, id):
         return self.annotation_branches.pop(id, None)

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/grid_axes.py

@@ -120,9 +120,14 @@ def grid(element, diagram, parent, outline_status):
 
     thickness = element.get('thickness', '1')
     stroke = element.get('stroke', r'#ccc')
+    id = element.get('id')
+    if id is None:
+        id = 'pf__grid'
+    if not id.startswith('pf__'):
+        id = 'pf__' + id
     grid = ET.SubElement(parent, 'g',
                          attrib={
-                             'id': element.get('id', 'grid'),
+                             'id': id,
                              'stroke': stroke,
                              'stroke-width': thickness
                          }
@@ -251,12 +256,14 @@ def grid(element, diagram, parent, outline_status):
         if x < bbox[0] or x > bbox[2]:
             continue
         line_el = line.mk_line((x,bbox[1]), (x,bbox[3]), diagram)
+        line_el.attrib.pop('id')
         grid.append(line_el)
 
     for y in y_positions:
         if y < bbox[1] or y > bbox[3]:
             continue
         line_el = line.mk_line((bbox[0], y), (bbox[2], y), diagram)
+        line_el.attrib.pop('id')
         grid.append(line_el)
 
 
@@ -266,27 +273,27 @@ def grid_axes(element, diagram, parent, outline_status):
     group = ET.SubElement(parent, 'g',
                           attrib=
                           {
-                              'id': 'grid-axes'
+                              'id': 'pf__grid-axes'
                           }
     )
 
     group_annotation = ET.Element('annotation')
-    group_annotation.set('ref', 'grid-axes')
+    group_annotation.set('ref', 'pf__grid-axes')
     group_annotation.set('text', 'The coordinate grid and axes')
     diagram. add_default_annotation(group_annotation)
 
     grid(element, diagram, group, outline_status)
 
     annotation = ET.Element('annotation')
-    annotation.set('ref', 'grid')
+    annotation.set('ref', 'pf__grid')
     annotation.set('text', 'The coordinate grid')
     group_annotation.append(annotation)
 
-    element.set('id', 'axes')
+    element.set('id', 'pf__axes')
     axes.axes(element, diagram, group, outline_status)
 
     annotation = ET.Element('annotation')
-    annotation.set('ref', 'axes')
+    annotation.set('ref', 'pf__axes')
     annotation.set('text', 'The coordinate axes')
     group_annotation.append(annotation)
 

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/legend.py

@@ -64,7 +64,7 @@ class Legend:
             # first we'll create the label
             label_el = copy.deepcopy(li)
             label_el.tag = 'label'
-            label_el.set('id', f"legend-label-{num}")
+            label_el.set('id', f"pf__legend-label-{num}")
             label_el.set('alignment', 'se')
             label_el.set('anchor', element.get('anchor', anchor_str))
             label_el.set('abs-offset', '(0,0)')
@@ -87,7 +87,7 @@ class Legend:
                 key = copy.deepcopy(key)
                 key.set('p', anchor_str)
                 key.set('size', '4')
-                key.set('id', f"legend-point-{num}")
+                key.set('id', f"pf__legend-point-{num}")
                 key_width = max(key_width, point_width)
             else:
                 fill =  key.get('fill')
@@ -219,11 +219,11 @@ class Legend:
             id = group.get('id', 'none')
             if id == 'background-group':
                 for rectangle in group:
-                    if rectangle.get('id', 'none').startswith('legend-label'):
+                    if rectangle.get('id', 'none').startswith('pf__legend-label'):
                         group.remove(rectangle)
             if id == 'braille-group':
                 for label in group:
-                    if label.get('id','none').startswith('legend-label'):
+                    if label.get('id','none').startswith('pf__legend-label'):
                         label_groups.append(label)
                         group.remove(label)
 

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/line.py

@@ -5,7 +5,11 @@ import logging
 from . import utilities as util
 from . import math_utilities as math_util
 from . import user_namespace as un
+import copy
 from . import arrow
+from . import group
+from . import label
+from . import CTM
 
 log = logging.getLogger('prefigure')
 
@@ -50,12 +54,24 @@ def line(element, diagram, parent, outline_status):
 
     line = mk_line(p1, p2, diagram, element.get('id', None), 
                    endpoint_offsets=endpoint_offsets)
+
+    # we need to hold on to the endpoints in case the line is labelled
+    # these are endpoints in SVG coordinates
+    x1 = float(line.get('x1'))
+    x2 = float(line.get('x2'))
+    y1 = float(line.get('y1'))
+    y2 = float(line.get('y2'))
+
+    q1 = np.array((x1, y1))
+    q2 = np.array((x2, y2))
+    diagram.save_data(element, {'q1': q1, 'q2': q2})
+
+    # now add the graphical attributes
     util.set_attr(element, 'stroke', 'black')
     util.set_attr(element, 'thickness', '2')
     if diagram.output_format() == 'tactile':
         element.set('stroke', 'black')
     util.add_attr(line, util.get_1d_attr(element))
-#    line.set('type', 'line')
 
     arrows = int(element.get('arrows', '0'))
     forward = 'marker-end'
@@ -113,15 +129,38 @@ def line(element, diagram, parent, outline_status):
         diagram.add_outline(element, line, parent)
         finish_outline(element, diagram, parent)
     else:
+        original_parent = parent
+        parent = add_label(element, diagram, parent)
         parent.append(line)
 
+        # if no label has been added, then we're done
+        if original_parent == parent:
+            return
+
+        # if there is a label, then the id is on the outer <g> element
+        # so we need to remove it from the children
+        remove_id(parent)
+
 def finish_outline(element, diagram, parent):
+    original_parent = parent
+    parent = add_label(element, diagram, parent)
+
+    # if we've added a label, remove the id's from element under the parent <g>
+    if original_parent != parent:
+        remove_id(parent)
+
     diagram.finish_outline(element,
                            element.get('stroke'),
                            element.get('thickness'),
                            element.get('fill', 'none'),
                            parent)
 
+def remove_id(el):
+    for child in el:
+        if child.get('id', None) is not None:
+            child.attrib.pop('id')
+        remove_id(child)
+
 # We'll be adding lines in other places so we'll use this more widely
 def mk_line(p0, p1, diagram, id = None, endpoint_offsets = None, user_coords = True):
     line = ET.Element('line')
@@ -176,3 +215,55 @@ def infinite_line(p0, p1, diagram, slope = None):
     if t_min > t_max:
         return None, None
     return [p + t * v for t in [t_min, t_max]]
+
+def add_label(element, diagram, parent):
+    # Is there a label associated with point?
+    text = element.text
+
+    # is there a label here?
+    has_text = text is not None and len(text.strip()) > 0
+    all_comments = all([subel.tag is ET.Comment for subel in element])
+    if has_text or not all_comments:
+        # If there's a label, we'll bundle the label and point in a group
+        parent_group = ET.SubElement(parent, 'g')
+        diagram.add_id(parent_group, element.get('id'))
+
+        # Now we'll create a new XML element describing the label
+        el = copy.deepcopy(element)
+        el.tag = 'label'
+
+        data = diagram.retrieve_data(element)
+        q1 = data['q1']
+        q2 = data['q2']
+
+        label_location = un.valid_eval(element.get("label-location", "0.5"))
+        if label_location < 0:
+            label_location = -label_location
+            q1, q2 = q2, q1
+
+        el.set('user-coords', 'no')
+        diff = q2 - q1
+        d = math_util.length(diff)
+        angle = math.degrees(math.atan2(diff[1], diff[0]))
+        if diagram.output_format() == "tactile":
+            anchor = q1 + label_location * diff
+            el.set("anchor", f"({anchor[0]}, {anchor[1]})")
+            direction = (diff[1], diff[0])
+            alignment = label.get_alignment_from_direction(direction)
+            el.set("alignment", alignment)
+            label.label(el, diagram, parent_group)
+        else:
+            tform = CTM.translatestr(*q1)
+            tform += ' ' + CTM.rotatestr(-angle)
+            distance = d * label_location
+            g = ET.SubElement(parent_group, "g")
+            g.set("transform", tform)
+            el.set("anchor", f"({distance},0)")
+            el.set("alignment", "north")
+            label.label(el, diagram, g)
+
+        return parent_group
+
+    else:
+        return parent
+

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/repeat.py

@@ -55,12 +55,15 @@ def repeat(element, diagram, parent, outline_status):
     element_cp = copy.deepcopy(element)
     outline = element.get('outline')
     id = element.get('id')
+    if not id.startswith('pf__'):
+        id = 'pf__' + id
     element.clear()
     element.tag = 'group'
     if outline is not None:
         element.set('outline', outline)
     if id is not None:
         element.set('id', id)
+        element_cp.set('id', id)
 
     for num, k in enumerate(iterator):
         if isinstance(k, np.ndarray):

{prefig-0.4.8 → prefig-0.5.1}/prefig/core/shape.py

@@ -36,7 +36,10 @@ def define(element, diagram, parent, outline_status):
             log.error(f"In <define-shapes>, {child.tag} does not define a shape")
             continue
         if child.get('at', None) is not None:
-            child.set('id', child.get('at'))
+            id = child.get('at')
+            if not id.startswith('pf__'):
+                id = 'pf__' + id
+            child.set('id', id)
         dummy_parent = ET.Element('group')
         # this is kind of a hack, but we only need to construct the shape
         # so we stash the format temporarily in case we're building a
@@ -69,6 +72,12 @@ def shape(element, diagram, parent, outline_status):
             return
 
     shape_refs = [r.strip() for r in reference.split(',')]
+    shape_edit = []
+    for shape_ref in shape_refs:
+        if not shape_ref.startswith('pf__'):
+            shape_ref = 'pf__' + shape_ref
+        shape_edit.append(shape_ref)
+    shape_refs = shape_edit
     shapes = []
     for ref in shape_refs:
         shapes.append(diagram.recall_shape(ref))
@@ -82,6 +91,8 @@ def shape(element, diagram, parent, outline_status):
             operation = 'union'
         else:
             path = ET.SubElement(parent, 'use')
+            if not reference.startswith('pf__'):
+                reference = 'pf__' + reference
             path.set('href', r'#' + reference)
 
     if operation is not None:

{prefig-0.4.8 → prefig-0.5.1}/prefig/resources/schema/pf_schema.rnc

@@ -584,7 +584,9 @@ Line = element line {
     attribute reverse {"yes"|"no"}?,
     attribute additional-arrows {"yes"|"no"}?,
     StrokeAttributes,
-    CommonAttributes    
+    CommonAttributes,
+    LabelAttributes,
+    LabelText?
 }
 
 Network = element network {

{prefig-0.4.8 → prefig-0.5.1}/prefig/resources/schema/pf_schema.rng

@@ -1613,6 +1613,10 @@
       </optional>
       <ref name="StrokeAttributes"/>
       <ref name="CommonAttributes"/>
+      <ref name="LabelAttributes"/>
+      <optional>
+        <ref name="LabelText"/>
+      </optional>
     </element>
   </define>
   <define name="Network">

{prefig-0.4.8 → prefig-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "prefig"
-version = "0.4.8"
+version = "0.5.1"
 description = "An authoring system for mathematical diagrams"
 readme = "README.md"
 homepage = "https://prefigure.org"