doc/api/python/xmlhelper-pysrc.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>xmlhelper</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         Module&nbsp;xmlhelper
       
    38       </span>
       
    39     </td>
       
    40     <td>
       
    41       <table cellpadding="0" cellspacing="0">
       
    42         <!-- hide/show private -->
       
    43         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    44     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    45         <tr><td align="right"><span class="options"
       
    46             >[<a href="frames.html" target="_top">frames</a
       
    47             >]&nbsp;|&nbsp;<a href="xmlhelper-pysrc.html"
       
    48             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    49       </table>
       
    50     </td>
       
    51   </tr>
       
    52 </table>
       
    53 <h1 class="epydoc">Source Code for <a href="xmlhelper-module.html">Module xmlhelper</a></h1>
       
    54 <pre class="py-src">
       
    55 <a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-comment">#============================================================================ </tt> </tt>
       
    56 <a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Name        : xmlhelper.py </tt> </tt>
       
    57 <a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Part of     : Helium </tt> </tt>
       
    58 <a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
       
    59 <a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-comment">#Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).</tt> </tt>
       
    60 <a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#All rights reserved.</tt> </tt>
       
    61 <a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#This component and the accompanying materials are made available</tt> </tt>
       
    62 <a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#under the terms of the License "Eclipse Public License v1.0"</tt> </tt>
       
    63 <a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#which accompanies this distribution, and is available</tt> </tt>
       
    64 <a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#at the URL "http://www.eclipse.org/legal/epl-v10.html".</tt> </tt>
       
    65 <a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
       
    66 <a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Initial Contributors:</tt> </tt>
       
    67 <a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Nokia Corporation - initial contribution.</tt> </tt>
       
    68 <a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
       
    69 <a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Contributors:</tt> </tt>
       
    70 <a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
       
    71 <a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#Description:</tt> </tt>
       
    72 <a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#===============================================================================</tt> </tt>
       
    73 <a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
       
    74 <a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
       
    75 <a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">amara</tt> </tt>
       
    76 <a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Method symrec.MetadataMerger.xml()=symrec.MetadataMerger-class.html#xml,Method symrec.ReleaseMetadata.xml()=symrec.ReleaseMetadata-class.html#xml"><a title="symrec.MetadataMerger.xml
       
    77 symrec.ReleaseMetadata.xml" class="py-name" href="#" onclick="return doclink('link-0', 'xml', 'link-0');">xml</a></tt><tt class="py-op">.</tt><tt class="py-name">dom</tt> <tt class="py-keyword">import</tt> <tt class="py-name">Node</tt> </tt>
       
    78 <a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line"> </tt>
       
    79 <a name="node_scan"></a><div id="node_scan-def"><a name="L24"></a><tt class="py-lineno">24</tt> <a class="py-toggle" href="#" id="node_scan-toggle" onclick="return toggle('node_scan');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmlhelper-module.html#node_scan">node_scan</a><tt class="py-op">(</tt><tt class="py-param">node</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
    80 </div><div id="node_scan-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="node_scan-expanded"><a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
       
    81 <a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"><tt class="py-docstring">        Replacement function for node.xml_xpath('./name').</tt> </tt>
       
    82 <a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line"><tt class="py-docstring">        name is a regular expression.</tt> </tt>
       
    83 <a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
       
    84 <a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">    <tt class="py-name">results</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
       
    85 <a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">subnode</tt> <tt class="py-keyword">in</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">childNodes</tt><tt class="py-op">:</tt> </tt>
       
    86 <a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">subnode</tt><tt class="py-op">.</tt><tt class="py-name">nodeType</tt> <tt class="py-op">==</tt> <tt class="py-name">Node</tt><tt class="py-op">.</tt><tt class="py-name">ELEMENT_NODE</tt> <tt class="py-keyword">and</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Method fileutils.AbstractScanner.match()=fileutils.AbstractScanner-class.html#match,Module pathaddition.match=pathaddition.match-module.html"><a title="fileutils.AbstractScanner.match
       
    87 pathaddition.match" class="py-name" href="#" onclick="return doclink('link-1', 'match', 'link-1');">match</a></tt><tt class="py-op">(</tt><tt id="link-2" class="py-name" targets="Method buildtools.Command.name()=buildtools.Command-class.html#name,Method ccm.FourPartName.name()=ccm.FourPartName-class.html#name,Method symrec.ServicePack.name()=symrec.ServicePack-class.html#name,Method sysdef.api.Configuration.name()=sysdef.api.Configuration-class.html#name,Method sysdef.api.Option.name()=sysdef.api.Option-class.html#name,Method sysdef.api.SpecialInstruction.name()=sysdef.api.SpecialInstruction-class.html#name,Method sysdef.api.Target.name()=sysdef.api.Target-class.html#name,Method sysdef.api.TargetList.name()=sysdef.api.TargetList-class.html#name,Method sysdef.api.Unit.name()=sysdef.api.Unit-class.html#name,Method sysdef.api._UnitGroup.name()=sysdef.api._UnitGroup-class.html#name"><a title="buildtools.Command.name
       
    88 ccm.FourPartName.name
       
    89 symrec.ServicePack.name
       
    90 sysdef.api.Configuration.name
       
    91 sysdef.api.Option.name
       
    92 sysdef.api.SpecialInstruction.name
       
    93 sysdef.api.Target.name
       
    94 sysdef.api.TargetList.name
       
    95 sysdef.api.Unit.name
       
    96 sysdef.api._UnitGroup.name" class="py-name" href="#" onclick="return doclink('link-2', 'name', 'link-2');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">subnode</tt><tt class="py-op">.</tt><tt class="py-name">nodeName</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
       
    97 <a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line">            <tt class="py-name">results</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Method ccm.Folder.append()=ccm.Folder-class.html#append,Method ccm.Task.append()=ccm.Task-class.html#append"><a title="ccm.Folder.append
       
    98 ccm.Task.append" class="py-name" href="#" onclick="return doclink('link-3', 'append', 'link-3');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">subnode</tt><tt class="py-op">)</tt> </tt>
       
    99 <a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">results</tt> </tt>
       
   100 </div><a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line"> </tt>
       
   101 <a name="recursive_node_scan"></a><div id="recursive_node_scan-def"><a name="L35"></a><tt class="py-lineno">35</tt> <a class="py-toggle" href="#" id="recursive_node_scan-toggle" onclick="return toggle('recursive_node_scan');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmlhelper-module.html#recursive_node_scan">recursive_node_scan</a><tt class="py-op">(</tt><tt class="py-param">node</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
       
   102 </div><div id="recursive_node_scan-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="recursive_node_scan-expanded"><a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
       
   103 <a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line"><tt class="py-docstring">        Replacement function for node.xml_xpath('.//name').</tt> </tt>
       
   104 <a name="L38"></a><tt class="py-lineno">38</tt>  <tt class="py-line"><tt class="py-docstring">        name is a regular expression.</tt> </tt>
       
   105 <a name="L39"></a><tt class="py-lineno">39</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
       
   106 <a name="L40"></a><tt class="py-lineno">40</tt>  <tt class="py-line">    <tt class="py-name">results</tt> <tt class="py-op">=</tt> <tt id="link-4" class="py-name" targets="Function xmlhelper.node_scan()=xmlhelper-module.html#node_scan"><a title="xmlhelper.node_scan" class="py-name" href="#" onclick="return doclink('link-4', 'node_scan', 'link-4');">node_scan</a></tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">,</tt> <tt id="link-5" class="py-name"><a title="buildtools.Command.name
       
   107 ccm.FourPartName.name
       
   108 symrec.ServicePack.name
       
   109 sysdef.api.Configuration.name
       
   110 sysdef.api.Option.name
       
   111 sysdef.api.SpecialInstruction.name
       
   112 sysdef.api.Target.name
       
   113 sysdef.api.TargetList.name
       
   114 sysdef.api.Unit.name
       
   115 sysdef.api._UnitGroup.name" class="py-name" href="#" onclick="return doclink('link-5', 'name', 'link-2');">name</a></tt><tt class="py-op">)</tt> </tt>
       
   116 <a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">subnode</tt> <tt class="py-keyword">in</tt> <tt class="py-name">node</tt><tt class="py-op">.</tt><tt class="py-name">childNodes</tt><tt class="py-op">:</tt>         </tt>
       
   117 <a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line">        <tt class="py-name">results</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt id="link-6" class="py-name" targets="Function xmlhelper.recursive_node_scan()=xmlhelper-module.html#recursive_node_scan"><a title="xmlhelper.recursive_node_scan" class="py-name" href="#" onclick="return doclink('link-6', 'recursive_node_scan', 'link-6');">recursive_node_scan</a></tt><tt class="py-op">(</tt><tt class="py-name">subnode</tt><tt class="py-op">,</tt> <tt id="link-7" class="py-name"><a title="buildtools.Command.name
       
   118 ccm.FourPartName.name
       
   119 symrec.ServicePack.name
       
   120 sysdef.api.Configuration.name
       
   121 sysdef.api.Option.name
       
   122 sysdef.api.SpecialInstruction.name
       
   123 sysdef.api.Target.name
       
   124 sysdef.api.TargetList.name
       
   125 sysdef.api.Unit.name
       
   126 sysdef.api._UnitGroup.name" class="py-name" href="#" onclick="return doclink('link-7', 'name', 'link-2');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
       
   127 <a name="L43"></a><tt class="py-lineno">43</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">results</tt> </tt>
       
   128 </div><a name="L44"></a><tt class="py-lineno">44</tt>  <tt class="py-line"> </tt><script type="text/javascript">
       
   129 <!--
       
   130 expandto(location.href);
       
   131 // -->
       
   132 </script>
       
   133 </pre>
       
   134 <br />
       
   135 <!-- ==================== NAVIGATION BAR ==================== -->
       
   136 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   137        bgcolor="#a0c0ff" cellspacing="0">
       
   138   <tr valign="middle">
       
   139 
       
   140   <!-- Tree link -->
       
   141       <th>&nbsp;&nbsp;&nbsp;<a
       
   142         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   143 
       
   144   <!-- Index link -->
       
   145       <th>&nbsp;&nbsp;&nbsp;<a
       
   146         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   147 
       
   148   <!-- Help link -->
       
   149       <th>&nbsp;&nbsp;&nbsp;<a
       
   150         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   151 
       
   152       <th class="navbar" width="100%"></th>
       
   153   </tr>
       
   154 </table>
       
   155 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   156   <tr>
       
   157     <td align="left" class="footer">
       
   158     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:25 2009
       
   159     </td>
       
   160     <td align="right" class="footer">
       
   161       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   162     </td>
       
   163   </tr>
       
   164 </table>
       
   165 
       
   166 <script type="text/javascript">
       
   167   <!--
       
   168   // Private objects are initially displayed (because if
       
   169   // javascript is turned off then we want them to be
       
   170   // visible); but by default, we want to hide them.  So hide
       
   171   // them unless we have a cookie that says to show them.
       
   172   checkCookie()
       
   173   // -->
       
   174 </script>
       
   175   
       
   176 </body>
       
   177 </html>