Minor tidying of MIME parser

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@7909 72102866-910b-0410-8b05-ffd578937521

Documentation/gsdoc/GSMimeDocument.gsdoc

@@ -59,6 +59,7 @@
 	    Create an empty MIME document.
           </desc>
         </method>
+
         <method type="BOOL">
           <sel>addHeader:</sel>
           <arg type="NSString*">aHeader</arg>
@@ -69,6 +70,7 @@
 	    added after all other headers in the document.
           </desc>
         </method>
+
         <method type="NSData*">
           <sel>boundary</sel>
           <desc>
@@ -77,6 +79,7 @@
 	    Otherwise, return nil.
           </desc>
         </method>
+
         <method type="id">
           <sel>content</sel>
           <desc>
@@ -92,6 +95,7 @@
 	    </deflist>
           </desc>
         </method>
+
         <method type="void">
           <sel>deleteHeader:</sel>
           <arg type="NSString*">aHeader</arg>
@@ -100,6 +104,7 @@
 	    exactly matches the supplied string.
 	  </desc>
 	</method>
+
         <method type="void">
           <sel>deleteHeaderNamed:</sel>
           <arg type="NSString*">aName</arg>
@@ -108,6 +113,7 @@
 	    matches the supplied string.
 	  </desc>
 	</method>
+
         <method type="NSArray">
           <sel>infoForAllHeaders</sel>
           <desc>
@@ -115,6 +121,7 @@
 	    represent all the headers of the document.
 	  </desc>
 	</method>
+
         <method type="NSDictionary*">
           <sel>infoForHeaderNamed:</sel>
           <arg type="NSString*">aName</arg>
@@ -123,6 +130,7 @@
 	    whose name equals the supplied argument.
 	  </desc>
 	</method>
+
         <method type="NSArray*">
           <sel>infoForHeadersNamed:</sel>
           <arg type="NSString*">aName</arg>
@@ -131,6 +139,7 @@
 	    whose names equal the supplied argument.
 	  </desc>
 	</method>
+
         <method type="BOOL">
           <sel>parseHeader:</sel>
           <arg type="NSScanner*">aScanner</arg>
@@ -157,6 +166,33 @@
 	    </p>
 	  </desc>
 	</method>
+
+        <method type="NSString*">
+          <sel>scanSpecial:</sel>
+          <arg type="NSScanner*">aScanner</arg>
+          <desc>
+	    A convenience method to use a scanner (that is set up to scan a
+	    header line) to scan in a special character that terminated a
+	    token previously scanned.  If the token was terminated by
+	    whitespace and no other special character, the string returned
+	    will contain a single space character.
+	  </desc>
+	</method>
+
+        <method type="NSString*">
+          <sel>scanToken:</sel>
+          <arg type="NSScanner*">aScanner</arg>
+          <desc>
+	    A convenience method to use a scanner (that is set up to scan a
+	    header line) to scan a header token - either a quoted string or
+	    a simple word.
+	    <list>
+	      <item>Leading whitespace is ignored.</item>
+	      <item>Backslash escapes in quoted text are converted</item>
+	    </list>
+	  </desc>
+	</method>
+
         <method type="BOOL">
           <sel>setContent:</sel>
           <arg type="id">newContent</arg>
@@ -164,6 +200,7 @@
 	    Sets a new value for the content of the document.
 	  </desc>
 	</method>
+
         <method type="BOOL">
           <sel>setHeader:</sel>
           <arg type="NSString*">aHeader</arg>
@@ -176,6 +213,7 @@
 	    the document.
           </desc>
         </method>
+
       </class>
     </chapter>
   </body>

Documentation/gsdoc/GSMimeDocument.html

@@ -80,8 +80,10 @@
 <li><a href ="GSMimeDocument.html#method-7">-infoForHeaderNamed:</a>
 <li><a href ="GSMimeDocument.html#method-8">-infoForHeadersNamed:</a>
 <li><a href ="GSMimeDocument.html#method-9">-parseHeader:named:inTo:</a>
-<li><a href ="GSMimeDocument.html#method-10">-setContent:</a>
-<li><a href ="GSMimeDocument.html#method-11">-setHeader:</a>
+<li><a href ="GSMimeDocument.html#method-10">-scanSpecial:</a>
+<li><a href ="GSMimeDocument.html#method-11">-scanToken:</a>
+<li><a href ="GSMimeDocument.html#method-12">-setContent:</a>
+<li><a href ="GSMimeDocument.html#method-13">-setHeader:</a>
 </ul>
 <hr><h2>Class Methods </h2>
 <h3><a name ="method-0">mimeDocument</a></h3>
@@ -186,13 +188,36 @@
 
 	  
  <hr>
-<h3><a name ="method-10">setContent:</a></h3>
+<h3><a name ="method-10">scanSpecial:</a></h3>
+- (NSString*) <b>scanSpecial:</b> (NSScanner*)aScanner;<br>
+
+	    A convenience method to use a scanner (that is set up to scan a
+	    header line) to scan in a special character that terminated a
+	    token previously scanned.  If the token was terminated by
+	    whitespace and no other special character, the string returned
+	    will contain a single space character.
+	  
+ <hr>
+<h3><a name ="method-11">scanToken:</a></h3>
+- (NSString*) <b>scanToken:</b> (NSScanner*)aScanner;<br>
+
+	    A convenience method to use a scanner (that is set up to scan a
+	    header line) to scan a header token - either a quoted string or
+	    a simple word.
+	    <ul>
+<li>Leading whitespace is ignored.
+<li>Backslash escapes in quoted text are converted
+</ul>
+
+	  
+ <hr>
+<h3><a name ="method-12">setContent:</a></h3>
 - (BOOL) <b>setContent:</b> (id)newContent;<br>
 
 	    Sets a new value for the content of the document.
 	  
  <hr>
-<h3><a name ="method-11">setHeader:</a></h3>
+<h3><a name ="method-13">setHeader:</a></h3>
 - (BOOL) <b>setHeader:</b> (NSString*)aHeader;<br>
 
 	    This method may be called to set a header in the document.