import copy

import warnings

import strings

import util

import xml_dom

##### Path elements

class XpathElem:

    def __init__(self, name='', value=None, is_attr=False):

        self.name = name

        self.is_positive = True

        self.is_lookup_only = False

        self.is_ptr = False

        self.other_branches = [] # temp implementation for split paths

        if not self.is_positive: str_ += '!'

        if self.is_attr: str_ += '@'

        if self.name == '': str_ += '""'

        if self.is_lookup_only: str_ += '?'

        if self.keys != []: str_ += strings.urepr(self.keys)

        if self.is_ptr: str_ += '->'

        if self.other_branches != []:

        return str_

empty_elem = XpathElem()

def is_self(elem): return elem.name == '' or elem.name == '.'

def is_all(elem): return elem.name == '*'

##### Paths

def is_xpath(value):

def path_is_empty(path): return path == [] or path == [empty_elem]

def is_positive(path): return path[0].is_positive

def is_rooted(path): return elem_is_empty(path[0])

def value(path): return path[-1].value

def set_value(path, value):

def append(path, subpath, i=0):

def backward_id(elem):

    if len(elem.keys) >= 1 and value(elem.keys[0]) == None: return elem.keys[0]

    else: return None

instance_level = 1 # root's grandchildren

    '''Caller must make a shallow copy of the path to prevent modifications from

    propagating to other copies of the path (a deep copy is not needed).

    if has_types: id_level = instance_level

    if is_self(path[0]): id_level += 1 # explicit root element

    id_attr = XpathElem('id', None, is_attr=True)

    id_path = obj(path) # a copy of the path up through the ID level

    id_path.append(copy.copy(id_attr)) # this path's id_attr is independent

def is_instance(elem): return elem.keys != [] and is_id(elem.keys[0])

import xpath_func

def expand_abbr(name, repl):

_cache = {}

def parse(str_):

    try: return _cache[str_]

    parser = Parser(str_)

    def _path():

        is_positive = not parser.str_('!')

        tree = []

            # Split path

            if parser.str_('{'):

                try: last = tree[-1]

                last.other_branches = _paths()

                tree += last.other_branches.pop(0) # use first path for now

                parser.str_('}', required=True)

                if parser.str_('/'): append(tree, _path()) # subpath after {}

                break # anything after split path has already been parsed

            elem = XpathElem(is_attr=parser.str_('@'), name=_value())

            elem.is_lookup_only = parser.str_('?')

            # Keys used to match nodes

            if parser.str_('['):

                elem.keys = _paths()

                parser.str_(']', required=True)

            # Attrs created when no matching node exists

            elem.is_ptr = parser.str_('->')

            tree.append(elem)

            if parser.str_('('):

                elem.keys.append(path)

                tree += path

            if not parser.str_('/'): break

        tree[0].is_positive = is_positive

        if parser.str_('='):

            if parser.str_('$'): # reference (different from a pointer)

            set_value(tree, value)

        # Expand * abbrs

        for i in reversed(xrange(len(tree))):

            if elem.is_ptr: offset = 2

            else: offset = 1

            try: repl = tree[i+offset].name

            except IndexError: pass # no replacement elem

        return tree

    def _value():

        else: value = parser.re(r'(?:(?:\w+:)*[\w.+*]+)?')

        return value

    def _paths():

        path = _path()

            if path_is_empty(paths[-1]): paths.pop() # remove trailing ","

        return paths

    path = _path()

    path = xpath_func.process(path)

    _cache[str_] = path

    return path

##### Querying/creating XML trees

def get(root, xpath, create=False, last_only=None, limit=1, allow_rooted=True):

    '''Warning: The last_only optimization may put data that should be together

    if last_only == None: last_only = create

    if limit == None or limit > 1: last_only = False

    if util.is_str(xpath): xpath = parse(xpath)

    # Handle edge cases

    if xpath == []: return [root]

    if create and not is_positive(xpath): return []

    doc = root.ownerDocument

    if allow_rooted and is_rooted(xpath): root = doc.documentElement

    elem = xpath[0]

        child = root.getAttributeNode(elem.name)

        if child != None: children = [child]

    elif is_self(elem): children = [root]

        parent = xml_dom.parent(root)

        if parent == None: return [] # don't try to create doc root's parent

    elif is_all(elem): children = list(xml_dom.NodeElemIter(root))

    else:

        children = xml_dom.by_tag_name(root, elem.name,

            last_only=(last_only and (elem.keys == [] or is_instance(elem))),

    # Retrieve elem value

        target = get_1(root, value_)

        else:

            warnings.warn(UserWarning('XPath reference target missing: '

                +strings.ustr(value_)+'\nXPath: '+strings.ustr(xpath)))

            value_ = None

    # Check each match

    nodes = []

    for child in children:

        is_match = value_ == None or xml_dom.value(child) == value_

        for attr in elem.keys:

            is_match = ((get(child, attr, False, last_only,

        if is_match:

    if nodes == []:

        if not create or elem.is_lookup_only: return []

        if elem.is_attr:

            root.setAttribute(elem.name, '')

        elif util.list_eq_is(children, [root]): node = root

        else: node = root.appendChild(doc.createElement(elem.name))

        if value_ != None: xml_dom.set_value(node, value_)

        nodes.append(node)

    path_value = value(xpath)

    xpath = xpath[1:] # rest of XPath

    next = []

            # Keys last so that any lookahead assertion's path will be created

                get(node, attr, create, last_only=False, allow_rooted=False)

            root = doc.documentElement

            xpath = copy.deepcopy(xpath)

                    if last != []: id_ = str(int(util.coalesce(

                    else: id_ = '0'

        next += get(root, xpath, create, last_only, limit, allow_rooted=False)

            branch = branch[:] # don't modify input!

            set_value(branch, path_value)

            next += get(node, branch, create, last_only, limit,

def get_1(*args, **kw_args):

def get_values(*args, **kw_args):

def get_value(*args, **kw_args):

def put_obj(root, xpath, id_, has_types, value=None):

    '''@return tuple(inserted_node, id_attr_node)'''

    if util.is_str(xpath): xpath = parse(xpath)

    xpath = xpath[:] # don't modify input!

    id_path = set_id(xpath, id_, has_types)

    if value != None: set_value(xpath, value)

    return (get_values(root, xpath, True), get_1(root, id_path))

def path2xml(xpath, first_branch=True):

    get(root, xpath, True)

    return root.firstChild # skip to tree created inside root

def xml_set_id(root, id_): xml_dom.set_id(root.firstChild, id_)