Error in xml.el documentation

Error in xml.el documentation

[Lennart Borgman (gmail)]

The documentation at the top of xml.el says

;; There can be only top level node, but with any number of children below.

;;; LIST FORMAT

;; The functions `xml-parse-file', `xml-parse-region' and
;; `xml-parse-tag' return a list with the following format:
;;
;;    xml-list   ::= (node node ...)

I think it should be "only one top level node" and

;;    xml-list   ::= node

Re: Error in xml.el documentation

[Lennart Borgman (gmail)]

Lennart Borgman (gmail) wrote:
> The documentation at the top of xml.el says
> 
> ;; There can be only top level node, but with any number of children below.
> 
> ;;; LIST FORMAT
> 
> ;; The functions `xml-parse-file', `xml-parse-region' and
> ;; `xml-parse-tag' return a list with the following format:
> ;;
> ;;    xml-list   ::= (node node ...)
> 
> I think it should be "only one top level node" and
> 
> ;;    xml-list   ::= node

Eh, xml-list ::= (list node)

Re: Error in xml.el documentation

[Jason Rumney]

Lennart Borgman (gmail) wrote:
> The documentation at the top of xml.el says
>
> ;; There can be only top level node, but with any number of children 
> below.
>
> I think it should be "only one top level node" and
>

Yes.

> ;; The functions `xml-parse-file', `xml-parse-region' and
> ;; `xml-parse-tag' return a list with the following format:
> ;;
> ;;    xml-list   ::= (node node ...)

This one is correct. The functions mentioned return a list of nodes. In 
the case of xml-parse-region at least, there can be more than one node 
at the top level of the returned list.

Re: Error in xml.el documentation

[Lennart Borgman (gmail)]

Jason Rumney wrote:
> Lennart Borgman (gmail) wrote:
>> The documentation at the top of xml.el says
>>
>> ;; There can be only top level node, but with any number of children 
>> below.
>>
>> I think it should be "only one top level node" and
>>
> 
> Yes.
> 
>> ;; The functions `xml-parse-file', `xml-parse-region' and
>> ;; `xml-parse-tag' return a list with the following format:
>> ;;
>> ;;    xml-list   ::= (node node ...)
> 
> This one is correct. The functions mentioned return a list of nodes. In 
> the case of xml-parse-region at least, there can be more than one node 
> at the top level of the returned list.

Thanks, I did not think of that case.

Re: Error in xml.el documentation

[Jason Rumney]

Lennart Borgman (gmail) wrote:
>>
>> This one is correct. The functions mentioned return a list of nodes. 
>> In the case of xml-parse-region at least, there can be more than one 
>> node at the top level of the returned list.
>
> Thanks, I did not think of that case.

But it seems I was wrong. xml-parse-region throws an error if the region 
does not contain well-formed XML with a single top-level node. So 
although the functions all return a list, they all always return a list 
of one.

Re: Error in xml.el documentation

[Lennart Borgman (gmail)]

Jason Rumney wrote:
> Lennart Borgman (gmail) wrote:
>>>
>>> This one is correct. The functions mentioned return a list of nodes. 
>>> In the case of xml-parse-region at least, there can be more than one 
>>> node at the top level of the returned list.
>>
>> Thanks, I did not think of that case.
> 
> But it seems I was wrong. xml-parse-region throws an error if the region 
> does not contain well-formed XML with a single top-level node. So 
> although the functions all return a list, they all always return a list 
> of one.

Though is not that a bug? Why should not multiple top-level nodes be 
allowed in that case?

Re: Error in xml.el documentation

[Lennart Borgman (gmail)]

Jason Rumney wrote:
> Lennart Borgman (gmail) wrote:
>>>
>>> This one is correct. The functions mentioned return a list of nodes. 
>>> In the case of xml-parse-region at least, there can be more than one 
>>> node at the top level of the returned list.
>>
>> Thanks, I did not think of that case.
> 
> But it seems I was wrong. xml-parse-region throws an error if the region 
> does not contain well-formed XML with a single top-level node. So 
> although the functions all return a list, they all always return a list 
> of one.

Would something like this fit in xml.el:

(defun freemind-get-child (parent path)
   (message "freemind-get-child %s %s" parent path)
   (let* ((childs (cddr parent))
          (step (car path))
          (step-node (if (listp step) (car step) step))
          (step-num  (if (listp step) (cdr step) 1))
          (path-tail (cdr path))
          (path-child (catch 'path-child
                        (dolist (child childs)
                          (when (and (not (stringp child))
                                     (eq step-node (car child)))
                            (when (= 1 step-num)
                              (throw 'path-child child))
                            (setq step-num (1- step-num)))))))
     (if path-tail
         (freemind-get-child path-child path-tail)
       path-child)))