No bug - Tidy some poor formatting in IDL files; rs=white-space-only
authorGeoff Lankow <geoff@darktrojan.net>
Tue, 08 Oct 2019 20:34:06 +1300
changeset 37101 83c4a792b5894bb4fad4908ec2ae235568d871aa
parent 37100 d8233c63b15f53d0810a4be5415b7897038fe82f
child 37102 e4dff5cebc88183fb993e949a9dcacaea064ca77
push id395
push userclokep@gmail.com
push dateMon, 02 Dec 2019 19:38:57 +0000
reviewerswhite-space-only
No bug - Tidy some poor formatting in IDL files; rs=white-space-only
mailnews/import/public/nsIImportAddressBooks.idl
mailnews/import/public/nsIImportFieldMap.idl
mailnews/import/public/nsIImportFilters.idl
mailnews/import/public/nsIImportGeneric.idl
mailnews/import/public/nsIImportMail.idl
mailnews/import/public/nsIImportMailboxDescriptor.idl
mailnews/import/public/nsIImportModule.idl
mailnews/import/public/nsIImportService.idl
mailnews/import/public/nsIImportSettings.idl
--- a/mailnews/import/public/nsIImportAddressBooks.idl
+++ b/mailnews/import/public/nsIImportAddressBooks.idl
@@ -27,26 +27,25 @@
   address books.  If it is not required then there will be no second panel.
   3) Show the progress dialog for the import - this could be per address book if
   mapping is required? what to do, what to doooooo.....
   4) All done, maybe a what was done panel??
 */
 
 #include "nsISupports.idl"
 
-interface   nsIFile;
-interface   nsIArray;
-interface  nsIImportABDescriptor;
-interface  nsIAddrDatabase;
-interface  nsIImportFieldMap;
+interface nsIFile;
+interface nsIArray;
+interface nsIImportABDescriptor;
+interface nsIAddrDatabase;
+interface nsIImportFieldMap;
 
 [scriptable, uuid(6bba48be-331c-41e3-bc9f-c2ea3754d977)]
 interface nsIImportAddressBooks : nsISupports
 {
-
   /*
     Does this interface supports 1 or 1..n address books.  You only
     get to choose 1 location so for formats where 1..n address books
     are imported from a directory, then return true.  For a 1 to 1 relationship
     between location and address books return false.
   */
   boolean GetSupportsMultiple();
 
@@ -54,33 +53,33 @@ interface nsIImportAddressBooks : nsISup
     If the address book is not found via a file location.then return true
     along with a description string of how or where the address book is
     located.  If it is a file location then return false.
     If true, return a string like: "Outlook Express standard address book,
     also known as the Windows address book" or just "Outlook Express address book".
     If false, GetDefaultLocation will be called.
   */
 
-  boolean GetAutoFind( out wstring description);
+  boolean GetAutoFind(out wstring description);
 
   /*
     Returns true if the address book needs the user to specify a field map
     for address books imported from this format.
   */
-  boolean GetNeedsFieldMap( in nsIFile location);
+  boolean GetNeedsFieldMap(in nsIFile location);
 
   /*
     If found and userVerify BOTH return false, then it is assumed that this
     means an error - address book cannot be found on this machine.
     If userVerify is true, the user will have an opportunity to specify
     a different location to import address book from.
   */
-  void   GetDefaultLocation( out nsIFile location,
-                out boolean  found,
-                out boolean  userVerify);
+  void GetDefaultLocation(out nsIFile location,
+                          out boolean found,
+                          out boolean userVerify);
   /*
     Returns an nsIArray which contains an nsIImportABDescriptor for each
     address book.  The array is not sorted before display to the user.
     location is null if GetAutoFind returned true.
   */
   nsIArray FindAddressBooks(in nsIFile location);
 
   /*
@@ -123,31 +122,25 @@ interface nsIImportAddressBooks : nsISup
     a different thread than ImportAddressBook()
   */
   unsigned long GetImportProgress();
 
   /*
     Set the location for reading sample data, this should be the same
     as what is passed later to FindAddressBooks
   */
-  void  SetSampleLocation( in nsIFile location);
+  void SetSampleLocation(in nsIFile location);
 
   /*
    * Return a string of sample data for a record, each field
    * is separated by a newline (which means no newlines in the fields!)
    * This is only supported by address books which use field maps and
    * is used by the field map UI to allow the user to properly
    * align fields to be imported.
    *
    * @param recordNumber index of the recrds, starting from 0.
    * @param recordExists true if the record exists.
    *
    * @returns a string of sample data for the desired record
    */
   wstring GetSampleData(in long recordNumber, out boolean recordExists);
 
 };
-
-
-
-%{ C++
-
-%}
--- a/mailnews/import/public/nsIImportFieldMap.idl
+++ b/mailnews/import/public/nsIImportFieldMap.idl
@@ -26,49 +26,49 @@ interface nsIImportFieldMap : nsISupport
 {
   /*
     Flag to indicate whether or not to skip the first record,
     for instance csv files often have field names as the first
     record
   */
   attribute boolean skipFirstRecord;
 
-  readonly attribute long  numMozFields;
-  readonly attribute long  mapSize;
+  readonly attribute long numMozFields;
+  readonly attribute long mapSize;
 
-  wstring GetFieldDescription( in long index);
+  wstring GetFieldDescription(in long index);
 
   /*
     Set the size of the field map, all unpopulated entries
     will default to -1
   */
-  void  SetFieldMapSize( in long size);
+  void SetFieldMapSize(in long size);
 
   /*
     Initialize the field map to a given size with default values
   */
-  void  DefaultFieldMap( in long size);
+  void DefaultFieldMap(in long size);
 
   /*
     Return the field number that this index maps to, -1 for no field
   */
-  long  GetFieldMap( in long index);
+  long GetFieldMap(in long index);
 
   /*
     Set the field that this index maps to, -1 for no field
   */
-  void  SetFieldMap( in long index, in long fieldNum);
+  void SetFieldMap(in long index, in long fieldNum);
 
   /*
     Return if this field is "active" in the map.
   */
-  boolean  GetFieldActive( in long index);
+  boolean GetFieldActive(in long index);
 
   /*
     Set the active state of this field
   */
-  void  SetFieldActive( in long index, in boolean active);
+  void SetFieldActive(in long index, in boolean active);
 
   /*
     Set the value of the given field in the database row
   */
-  void  SetFieldValue( in nsIAddrDatabase database, in nsIMdbRow row, in long fieldNum, in wstring value);
+  void SetFieldValue(in nsIAddrDatabase database, in nsIMdbRow row, in long fieldNum, in wstring value);
 };
--- a/mailnews/import/public/nsIImportFilters.idl
+++ b/mailnews/import/public/nsIImportFilters.idl
@@ -9,17 +9,17 @@
 
 #include "nsISupports.idl"
 
 interface nsIFile;
 
 [scriptable, uuid(f2680ccf-d110-4b5b-954d-e072d4a16129)]
 interface nsIImportFilters : nsISupports
 {
-  boolean  AutoLocate( out wstring aDescription, out nsIFile aLocation);
+  boolean AutoLocate(out wstring aDescription, out nsIFile aLocation);
 
-  void     SetLocation( in nsIFile aLocation);
+  void SetLocation(in nsIFile aLocation);
 
   /*
     Import filters and put any problems in the error out parameter.
   */
-  boolean  Import( out wstring aError);
+  boolean Import(out wstring aError);
 };
--- a/mailnews/import/public/nsIImportGeneric.idl
+++ b/mailnews/import/public/nsIImportGeneric.idl
@@ -23,67 +23,61 @@ interface nsIImportGeneric : nsISupports
       "mailLocation" - nsIFile, source location for mail
 
       "addressInterface" - nsIImportAddressBooks interface
       "addressBooks" - nsIArray of nsIImportABDescriptors
       "addressLocation" - src location of address books (if needed!)
       "addressDestination" - uri of destination address book or null if
                 new address books will be created.
     */
-  nsISupports  GetData( in string dataId);
+  nsISupports GetData(in string dataId);
 
-  void    SetData( in string dataId, in nsISupports pData);
+  void SetData(in string dataId, in nsISupports pData);
 
     /*
       "isInstalled" - if true then mail can be automatically located.
       "canUserSetLocation" - if true then the user can specify the location
         to look for mail.  If both are false, then there is no way
         to import mail from this format!
         TBD: How to specify whether or not a file or a directory
         should be specified?
       "autoFind" - for address books, is the address book located without
         using the file system - i.e. addressLocation is irrelevant.
       "supportsMultiple" - 1 or 1..n address books are imported by this format?
 
     */
-  long    GetStatus( in string statusKind);
+  long GetStatus(in string statusKind);
 
   /*
     When you are ready to import call this.  If it returns TRUE then
     you must call BeginImport and then repeatedly call GetProgress until
     it returns 100 % done or until ContinueImport returns FALSE.
     If this returns FALSE then BeginImport will begin and finish the import
     before it returns.
   */
-  boolean    WantsProgress();
+  boolean WantsProgress();
 
   /* Use these for the actual import */
     /* Begin import is expected to start a new thread UNLESS WantsProgress returned
       FALSE.  It is REQUIRED to call WantsProgress before calling BeginImport.
       If WantsProgress was false then this will return the success or
       failure of the import.  Failure can be reported even if WantsProgress
       returned TRUE.
      */
   boolean BeginImport(in nsISupportsString successLog,
                       in nsISupportsString errorLog);
     /*
       If WantsProgress returned TRUE then this will indicate if the import should
       continue.  If this returns FALSE then no other methods should be called
       and the error log should be shown to the user.
     */
-  boolean    ContinueImport();
+  boolean ContinueImport();
     /*
       Returns the percentage done.  When this returns 100 then the import is done.
       (only valid if WantsProgress returned true)
     */
-  long    GetProgress();
+  long GetProgress();
     /*
       Cancel an import in progress.  Again, this is only valid if WantsProgress
       returned true.
     */
-  void    CancelImport();
+  void CancelImport();
 };
-
-
-
-%{ C++
-
-%}
--- a/mailnews/import/public/nsIImportMail.idl
+++ b/mailnews/import/public/nsIImportMail.idl
@@ -38,43 +38,42 @@
 interface nsIFile;
 interface nsIArray;
 interface nsIImportMailboxDescriptor;
 interface nsIMsgFolder;
 
 [scriptable, uuid(a14a3308-0849-420b-86d3-13a2948b5504)]
 interface nsIImportMail : nsISupports
 {
-
   /*
     If found and userVerify BOTH return false, then it is assumed that this
     means an error - mail cannot be found on this machine.
     If userVerify is true, the user will have an opportunity to specify
     a different location to import mail from.
   */
-  void   GetDefaultLocation( out nsIFile location,
-                out boolean  found,
-                out boolean  userVerify);
+  void GetDefaultLocation(out nsIFile location,
+                          out boolean found,
+                          out boolean userVerify);
   /*
     Returns an nsIArray which contains an nsIImportMailboxID for each
     mailbox.  The array is not sorted before display to the user.
   */
   nsIArray FindMailboxes(in nsIFile location);
 
   /*
     Import a specific mailbox into the destination folder supplied.  If an error
     occurs that is non-fatal, the destination will be deleted and other mailboxes
     will be imported.  If a fatal error occurs, the destination will be deleted
     and the import operation will abort.
   */
-  void   ImportMailbox(in nsIImportMailboxDescriptor source,
-                       in nsIMsgFolder dstFolder,
-                       out wstring errorLog,
-                       out wstring successLog,
-                       out boolean fatalError);
+  void ImportMailbox(in nsIImportMailboxDescriptor source,
+                     in nsIMsgFolder dstFolder,
+                     out wstring errorLog,
+                     out wstring successLog,
+                     out boolean fatalError);
 
   /*
     Return the amount of the mailbox that has been imported so far.  This number
     is used to present progress information and must never be larger than the
     size specified in nsIImportMailboxID.GetSize();  May be called from
     a different thread than ImportMailbox()
   */
   unsigned long GetImportProgress();
@@ -83,16 +82,14 @@ interface nsIImportMail : nsISupports
    * When migrating the local folders from the import source into mozilla,
    * we want to translate reserved folder names from the import source to
    * equivalent values for Mozilla.
    * Localization Impact is unknown here.
    */
   AString translateFolderName(in AString aFolderName);
 };
 
-
-
 %{ C++
 #define kDestTrashFolderName "Trash"
 #define kDestUnsentMessagesFolderName "Unsent Messages"
 #define kDestSentFolderName "Sent"
 #define kDestInboxFolderName "Inbox"
 %}
--- a/mailnews/import/public/nsIImportMailboxDescriptor.idl
+++ b/mailnews/import/public/nsIImportMailboxDescriptor.idl
@@ -14,28 +14,26 @@
 #include "nsISupports.idl"
 
 interface nsIFile;
 
 [scriptable, uuid(69eba744-9c4f-4f79-a964-2134746b3656)]
 interface nsIImportMailboxDescriptor : nsISupports
 {
   attribute unsigned long identifier;
-  attribute unsigned long  depth;
-  attribute unsigned long  size;
+  attribute unsigned long depth;
+  attribute unsigned long size;
 
-  wstring  GetDisplayName();
-  void  SetDisplayName( [const] in wstring name);
+  wstring GetDisplayName();
+  void SetDisplayName([const] in wstring name);
 
   attribute boolean import;
   readonly attribute nsIFile file;
 };
 
-
-
 %{ C++
 
 /*
   The default implementation can be obtained from
   nsIImportService::CreateNewMailboxDescriptor();
 
   You should only be interested in using this class if you implement
   the nsIImportMail interface in which case, just using the service to
--- a/mailnews/import/public/nsIImportModule.idl
+++ b/mailnews/import/public/nsIImportModule.idl
@@ -6,27 +6,25 @@
 /*
 
   An import module.
 
  */
 
 #include "nsISupports.idl"
 
-
 [scriptable, uuid(624f0280-173f-11d3-a206-00a0cc26da63)]
 interface nsIImportModule : nsISupports
 {
-  readonly attribute wstring   name;
-  readonly attribute wstring   description;
-  readonly attribute string   supports;
-  readonly attribute boolean  supportsUpgrade;
+  readonly attribute wstring name;
+  readonly attribute wstring description;
+  readonly attribute string supports;
+  readonly attribute boolean supportsUpgrade;
 
   nsISupports GetImportInterface( in string importType);
 };
 
-
 %{ C++
 #define NS_IMPORT_MAIL_STR      "mail"
 #define NS_IMPORT_ADDRESS_STR   "addressbook"
 #define NS_IMPORT_SETTINGS_STR  "settings"
 #define NS_IMPORT_FILTERS_STR   "filters"
 %}
--- a/mailnews/import/public/nsIImportService.idl
+++ b/mailnews/import/public/nsIImportService.idl
@@ -19,30 +19,30 @@ interface nsIImportFieldMap;
 interface nsIMsgSendListener;
 interface nsIMsgIdentity;
 interface nsIMsgCompFields;
 interface nsIArray;
 
 [scriptable, uuid(d0ed4c50-5997-49c9-8a6a-045f0680ed29)]
 interface nsIImportService : nsISupports
 {
-    void DiscoverModules();
+  void DiscoverModules();
 
-  long GetModuleCount( in string filter);
-  void GetModuleInfo( in string filter, in long index, out wstring name, out wstring description);
-  wstring GetModuleName( in string filter, in long index);
-  wstring GetModuleDescription( in string filter, in long index);
-  nsIImportModule  GetModule( in string filter, in long index);
-  nsIImportModule GetModuleWithCID( in nsCIDRef cid);
+  long GetModuleCount(in string filter);
+  void GetModuleInfo(in string filter, in long index, out wstring name, out wstring description);
+  wstring GetModuleName(in string filter, in long index);
+  wstring GetModuleDescription(in string filter, in long index);
+  nsIImportModule  GetModule(in string filter, in long index);
+  nsIImportModule GetModuleWithCID(in nsCIDRef cid);
 
-  nsIImportFieldMap      CreateNewFieldMap();
-  nsIImportMailboxDescriptor  CreateNewMailboxDescriptor();
-  nsIImportABDescriptor    CreateNewABDescriptor();
-  nsIImportGeneric      CreateNewGenericMail();
-  nsIImportGeneric      CreateNewGenericAddressBooks();
+  nsIImportFieldMap CreateNewFieldMap();
+  nsIImportMailboxDescriptor CreateNewMailboxDescriptor();
+  nsIImportABDescriptor CreateNewABDescriptor();
+  nsIImportGeneric CreateNewGenericMail();
+  nsIImportGeneric CreateNewGenericAddressBooks();
   void CreateRFC822Message(in nsIMsgIdentity aIdentity,
                            in nsIMsgCompFields aMsgFields,
                            in string aBodytype,
                            in ACString aBody,
                            in boolean aCreateAsDraft,
                            in nsIArray aLoadedAttachments,
                            in nsIArray aEmbeddedObjects,
                            in nsIMsgSendListener aListener);
--- a/mailnews/import/public/nsIImportSettings.idl
+++ b/mailnews/import/public/nsIImportSettings.idl
@@ -13,27 +13,21 @@
 #include "nsISupports.idl"
 
 interface nsIMsgAccount;
 interface nsIFile;
 
 [scriptable, uuid(1c0e3012-bc4d-4fb2-be6a-0335c7bab9ac)]
 interface nsIImportSettings : nsISupports
 {
-  boolean    AutoLocate( out wstring description, out nsIFile location);
+  boolean AutoLocate(out wstring description, out nsIFile location);
 
-  void    SetLocation( in nsIFile location);
+  void SetLocation(in nsIFile location);
 
   /*
     Create all of the accounts, identities, and servers.  Return an
     account where any local mail from this app should be imported.
     The returned account can be null which indicates that no suitable
     account for local mail was created and a new account specifically for
     the imported mail should be created.
   */
-  boolean    Import( out nsIMsgAccount localMailAccount);
+  boolean Import(out nsIMsgAccount localMailAccount);
 };
-
-
-
-%{ C++
-
-%}