Merge pull request #825 from EugeneZelenko/lay-tl-spell-check

Fix misspellings in lay and tl.

src/lay/lay/gsiDeclLayApplication.cc

@@ -171,7 +171,7 @@ static gsi::Methods application_methods ()
       "@brief Reads the configuration from a file\n"
       "@return A value indicating whether the operation was successful\n"
       "\n"
-      "This method siletly does nothing, if the config file does not\n"
+      "This method silently does nothing, if the config file does not\n"
       "exist. If it does and an error occurred, the error message is printed\n"
       "on stderr. In both cases, false is returned.\n"
     ) +

src/lay/lay/gsiDeclLayMainWindow.cc

@@ -645,7 +645,7 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
     "Starting from version 0.25, this method enables/disables edits on the current view only. \n"
     "Use LayoutView#enable_edits instead.\n"
   ) +
-  gsi::method ("synchronous=|#synchroneous", &lay::MainWindow::set_synchronous, gsi::arg ("sync_mode"),
+  gsi::method ("synchronous=|#synchronous", &lay::MainWindow::set_synchronous, gsi::arg ("sync_mode"),
     "@brief Puts the main window into synchronous mode\n"
     "\n"
     "@param sync_mode 'true' if the application should behave synchronously\n"

src/lay/lay/layApplication.cc

@@ -954,7 +954,7 @@ ApplicationBase::usage ()
   r += tl::to_string (QObject::tr ("  -p <plugin>         Load the plugin (can be used multiple times)")) + "\n";
   r += tl::to_string (QObject::tr ("  -r <script>         Execute main script on startup (after having loaded files etc.)")) + "\n";
   r += tl::to_string (QObject::tr ("  -rm <script>        Execute module on startup (can be used multiple times)")) + "\n";
-  r += tl::to_string (QObject::tr ("  -rd <name>=<value>  Specify skript variable")) + "\n";
+  r += tl::to_string (QObject::tr ("  -rd <name>=<value>  Specify script variable")) + "\n";
   r += tl::to_string (QObject::tr ("  -rx                 Ignore all implicit macros (*.rbm, rbainit, *.lym)")) + "\n";
   r += tl::to_string (QObject::tr ("  -s                  Load files into same view")) + "\n";
   r += tl::to_string (QObject::tr ("  -t                  Don't update the configuration file on exit")) + "\n";

src/lay/lay/layApplication.h

@@ -181,7 +181,7 @@ public:
   /**
    *  @brief Read the configuration from a file
    *
-   *  This method siletly does nothing, if the config file does not
+   *  This method silently does nothing, if the config file does not
    *  exist. If it does and an error occurred, the error message is printed
    *  on stderr. In both cases, false is returned.
    */

src/lay/lay/layHelpSource.cc

@@ -213,7 +213,7 @@ static QString topic_element = QString::fromUtf8 ("topic");
 static QString topics_element = QString::fromUtf8 ("topics");
 
 /**
- *  @brief A specialisation of tl::make_element that is capable of taking a std::map::const_iterator 
+ *  @brief A specialization of tl::make_element that is capable of taking a std::map::const_iterator 
  *
  *  The original tl::make_element gives a compiler warning (taking address of temporary)
  *  TODO: consolidate this version and tl::make_element.
@@ -601,7 +601,7 @@ HelpSource::produce_main_index ()
 
   os << "<p>" << tl::to_string (QObject::tr ("Welcome to KLayout's documentation")) << "</p>" << std::endl;
   os << "<p>" << tl::to_string (QObject::tr (
-    "The documentation is organised in chapters.\n"
+    "The documentation is organized in chapters.\n"
     "For a brief introduction read the User Manual. 'Various Topics' is a collection of brief articles about specific topics.\n"
     "For Ruby programming see the 'Programming Ruby Scripts' chapter and for a complete Ruby class reference see the 'Class Index'.\n"
   ));

src/lay/lay/layHelpSource.h

@@ -68,7 +68,7 @@ struct IndexEntry
 std::string escape_xml (const std::string &s);
 
 /**
- *  @brief A specialisation of BrowserSource for delivering the generated documentation
+ *  @brief A specialization of BrowserSource for delivering the generated documentation
  */
 class HelpSource
   : public BrowserSource

src/lay/lay/layMacroEditorPage.cc

@@ -1711,7 +1711,7 @@ MacroEditorPage::eventFilter (QObject *watched, QEvent *event)
 
       } else if (is_find_next_key (ke)) {
 
-        //  Jump to the next occurence of the search string
+        //  Jump to the next occurrence of the search string
 
         if (m_current_search != QRegExp ()) {
           if ((ke->modifiers () & Qt::ShiftModifier) != 0) {

src/lay/lay/layMacroEditorSetupPage.cc

@@ -359,7 +359,7 @@ MacroEditorSetupPage::commit_attributes (QListWidgetItem *to_item)
 
   }
 
-  //  update all list styles (because we may modifiy a basic entry, we have to update dependent ones as well)
+  //  update all list styles (because we may modify a basic entry, we have to update dependent ones as well)
   for (int i = 0; i < styles_list->count (); ++i) {
 
     QListWidgetItem *item = styles_list->item (i);

src/lay/lay/layMainConfigPages.cc

@@ -418,7 +418,7 @@ CustomizeMenuConfigPage::apply (const std::vector<std::pair<std::string, std::st
     m_hidden_flags.insert (std::make_pair (kb->first, hh != h.end () && hh->second));
   }
 
-  //  extract the top level menues
+  //  extract the top level menus
   std::map <std::string, std::string> top_level_menus;
   top_level_menus.insert (std::make_pair (std::string (), tl::to_string (QObject::tr ("Main Menu"))));
   top_level_menus.insert (std::make_pair (std::string ("secrets"), tl::to_string (QObject::tr ("Key Binding Targets"))));

src/lay/lay/layMainWindow.h

@@ -649,13 +649,13 @@ public slots:
 
   /**
    *  @brief shows the given URL as a non-modal help window
-   *  Intended as a connection target for QLabel linkVisisted signals.
+   *  Intended as a connection target for QLabel linkVisited signals.
    */
   void show_help (const QString &url);
 
   /**
    *  @brief shows the given URL as a modal help window
-   *  Intended as a connection target for QLabel linkVisisted signals.
+   *  Intended as a connection target for QLabel linkVisited signals.
    */
   void show_modal_help (const QString &url);
 

src/lay/lay/laySalt.cc

@@ -199,7 +199,7 @@ Salt::validate ()
       m_grains_by_name.insert (std::make_pair ((*i)->name (), *i));
     }
 
-    //  Compute a set of topological indexes. Packages which serve depedencies of other packages have a higher
+    //  Compute a set of topological indexes. Packages which serve dependencies of other packages have a higher
     //  topological index. Later we sort the packages by descending topo index to ensure the packages which are
     //  input to others come first.
 

src/lay/lay/laySaltGrainDetailsTextWidget.h

@@ -34,7 +34,7 @@ namespace lay
 class SaltGrain;
 
 /**
- *  @brief A specialisation of QTextBrowser that displays the details of the salt grain
+ *  @brief A specialization of QTextBrowser that displays the details of the salt grain
  */
 class SaltGrainDetailsTextWidget
   : public QTextBrowser

src/lay/lay/laySignalHandler.cc

@@ -351,7 +351,7 @@ void signal_handler (int signo, siginfo_t *si, void *)
 
       if (has_addr2line) {
 
-        //  two tries: one with the relativew address (for shared object) and one with
+        //  two tries: one with the relative address (for shared object) and one with
         //  absolute address.
         //  TODO: is there a better way to decide how to use addr2line (with executables)?
         for (int abs_addr = 0; abs_addr < 2; ++abs_addr) {

src/lay/lay/laySystemPaths.h

@@ -46,7 +46,7 @@ LAY_PUBLIC std::string get_appdata_path ();
  *  This is a path (in the sense of a search path - i.e. multiple paths)
  *  where KLayout (and derived applications) looks for configuration files.
  *  The path is created from the appdata and inst path by default. It can
- *  be overridden by the KLAYOUT_PATH enviroment variable.
+ *  be overridden by the KLAYOUT_PATH environment variable.
  */
 LAY_PUBLIC std::vector<std::string> get_klayout_path ();
 

src/tl/tl/tlCommandLineParser.h

@@ -79,7 +79,7 @@ public:
    *    "[group]..."              - List the option under this group (group = group title)
    *    "#..."                    - Advanced option - listed with --help-all only
    *    "/..."                    - Non-advanced option - listed with -h|--help only
-   *    "*..."                    - Multiple occurances allowed - values needs to be
+   *    "*..."                    - Multiple occurrences allowed - values needs to be
    *                                an array and values are accumulated. Without *, the
    *                                value string is evaluated to a comma-separated list.
    *                                "*" means one occurrence at least unless combined with "?".

src/tl/tl/tlCopyOnWrite.h

@@ -125,7 +125,7 @@ public:
   explicit copy_on_write_ptr (const copy_on_write_ptr<X, Dup> &other)
     : mp_holder (other.mp_holder)
   {
-    aquire ();
+    acquire ();
   }
 
   copy_on_write_ptr &operator= (const copy_on_write_ptr<X, Dup> &other)
@@ -133,7 +133,7 @@ public:
     if (this != &other) {
       release ();
       mp_holder = other.mp_holder;
-      aquire ();
+      acquire ();
     }
     return *this;
   }
@@ -250,7 +250,7 @@ private:
     }
   }
 
-  void aquire ()
+  void acquire ()
   {
     if (mp_holder) {
       tl::MutexLocker locker (&ms_lock);

src/tl/tl/tlDataMapping.cc

@@ -429,7 +429,7 @@ DataMappingLookupTable::update_table (double xmin, double xmax, double delta_y,
       mp_y[i] = interpolate (table, t, x);
     }
 
-    //  add one item for satefy (rounding problems in operator[] implementation)
+    //  add one item for safety (rounding problems in operator[] implementation)
     mp_y[i] = mp_y[i - 1];
     m_xmin = xmin - delta_x * 0.5;
     m_dxinv = 1.0 / delta_x;

src/tl/tl/tlDataMapping.h

@@ -36,7 +36,7 @@ namespace tl
  *  @brief A generic class that maps some scalar value to another scalar values
  * 
  *  The mapping is given by a table of sorted values x and associated y which are
- *  interpolated linearily. A data mapping object must be capable of generating 
+ *  interpolated linearly. A data mapping object must be capable of generating 
  *  such a table. 
  *  Data mapping expressions can be built by concatenating data mapping operators.
  */
@@ -219,7 +219,7 @@ private:
 };
 
 /**
- *  @brief Linar combination of two data mappings
+ *  @brief Linear combination of two data mappings
  *
  *  This data mapping is composed of two mappings a and b and offers two coefficients ca and cb and a constant c. 
  *  The result is:

src/tl/tl/tlDeflate.h

@@ -145,7 +145,7 @@ public:
    *  @brief Destructor
    *
    *  Note that this method will not flush the stream since that may 
-   *  throw an exception. flush() has to be called explcitly.
+   *  throw an exception. flush() has to be called explicitly.
    */
   ~DeflateFilter ();
 

src/tl/tl/tlEvents.cc

@@ -30,14 +30,14 @@ namespace tl
 
 void handle_event_exception (tl::Exception &ex)
 {
-  //  Exceptions have unpredicable side effects for events so we just log
+  //  Exceptions have unpredictable side effects for events so we just log
   //  them here.
   tl::warn << ex.msg ();
 }
 
 void handle_event_exception (std::exception &ex)
 {
-  //  Exceptions have unpredicable side effects for events so we just log
+  //  Exceptions have unpredictable side effects for events so we just log
   //  them here.
   tl::warn << ex.what ();
 }

src/tl/tl/tlEvents.h

@@ -92,7 +92,7 @@ TL_PUBLIC void handle_event_exception (std::exception &ex);
  *
  *  @endcode
  *
- *  Events can be given a disamibguation or client data parameter:
+ *  Events can be given a disambiguation or client data parameter:
  *
  *  @code
  *

src/tl/tl/tlHttpStream.h

@@ -97,7 +97,7 @@ public:
   static bool is_available ();
 
   /**
-   *  @brief Polling: call this function regularily to explicitly establish polling
+   *  @brief Polling: call this function regularly to explicitly establish polling
    *  (in the Qt framework, this is done automatically within the event loop)
    */
   void tick ();
@@ -147,7 +147,7 @@ public:
 
   /**
    *  @brief Gets the "ready" event
-   *  Connect to this event for the asynchroneous interface.
+   *  Connect to this event for the asynchronous interface.
    *  This event is fired when data becomes available or the
    *  connection has terminated with an error.
    */

src/tl/tl/tlHttpStreamCurl.h

@@ -103,7 +103,7 @@ public:
 
   /**
    *  @brief Gets the "ready" event
-   *  Connect to this event for the asynchroneous interface.
+   *  Connect to this event for the asynchronous interface.
    *  This event is fired when the request has finished.
    */
   tl::Event &ready ()
@@ -121,7 +121,7 @@ public:
 
   /**
    *  @brief Gets the "data available" event
-   *  Connect to this event for the asynchroneous interface.
+   *  Connect to this event for the asynchronous interface.
    *  This event is fired when data becomes available for read.
    *  It is just fired once.
    */

src/tl/tl/tlKDTree.h

@@ -543,9 +543,9 @@ public:
    *  @brief search initiation
    *
    *  The model used in the search follows the usual begin..end 
-   *  iterator semantics. However, begin and end are assymmetric:
+   *  iterator semantics. However, begin and end are asymmetric:
    *  While "sel_begin" creates, initializes and delivers a iterator
-   *  which walks through the tree skipping irrelvant items, the
+   *  which walks through the tree skipping irrelevant items, the
    *  "sel_end" methods just delivers a "token" which is matched by
    *  the iterators comparison operator against the "done" state.
    *  

src/tl/tl/tlObject.h

@@ -44,7 +44,7 @@ class WeakOrSharedPtr;
  *  formation. tl::Object is a neutral and empty class. It only provides
  *  the infrastructure for the shared pointer management.
  *
- *  The shared and weak pointer infracstructure contains of
+ *  The shared and weak pointer infrastructure contains of
  *
  *  1.) A shared pointer class (tl::shared_ptr<T>). All shared pointers
  *      share ownership of the contained object. When the last shared

src/tl/tl/tlProgress.h

@@ -67,7 +67,7 @@ template <> struct type_traits<tl::AbsoluteProgress> : public type_traits<void>
  *  @brief A helper class to clean up pending progress objects
  *
  *  Pending progress objects may be created in scripts. If scripts are aborted
- *  (e.g. in the debugger), progress objects may stay behing a block the application.
+ *  (e.g. in the debugger), progress objects may stay behind a block the application.
  *  To prevent this, this object keeps track of progress objects created between
  *  it's constructor and destructor and cleans up the objects created but not
  *  destroyed.

src/tl/tl/tlRecipe.h

@@ -107,7 +107,7 @@ private:
 };
 
 /**
- *  @brief A facility for providing reproducable recipes
+ *  @brief A facility for providing reproducible recipes
  *
  *  The idea of this facility is to provide a service by which an object
  *  can be reproduced in a parametrized way. The intended use case is a 

src/tl/tl/tlReuseVector.h

@@ -773,7 +773,7 @@ public:
   void insert (const Iter &from, const Iter &to)
   {
     if (! (from == to)) {
-      //  don't reservce if the first element of the sequence comes from ourself.
+      //  don't reserve if the first element of the sequence comes from ourself.
       //  This implies that we try to duplicate our own elements which would invalidate
       //  the source upon reservation.
       if (! (&*from >= mp_start && &*from < mp_finish)) {
@@ -884,7 +884,7 @@ public:
   /**
    *  @brief Reserve space for a given number of elements
    *
-   *  This guarantees that for the next n-size() inserts no reallocation will occure
+   *  This guarantees that for the next n-size() inserts no reallocation will occur
    *  No resizing will happen, if n is less than the current capacity.
    */
   void reserve (size_type n)

src/tl/tl/tlSleep.h

@@ -35,7 +35,7 @@ namespace tl
 TL_PUBLIC void usleep (unsigned long us);
 
 /**
- *  @brief Slees the given number of milliseconds
+ *  @brief Sleeps the given number of milliseconds
  */
 TL_PUBLIC void msleep (unsigned long ms);
 

src/tl/tl/tlStream.h

@@ -68,7 +68,7 @@ public:
    *  @brief Read a block of n bytes
    *
    *  Read the requested number of bytes or less.
-   *  May throw an exception if a read error occures.
+   *  May throw an exception if a read error occurs.
    *  
    *  @param b The buffer where to write to
    *  @param n The number of bytes to read (or less)
@@ -421,7 +421,7 @@ public:
    *  
    *  This implementation obtains data through the 
    *  protected read call and buffers the data accordingly so
-   *  a contigous memory block can be returned.
+   *  a contigious memory block can be returned.
    *  If inline deflating is enabled, the method will return
    *  inflate data unless "bypass_inflate" is set to true.
    *
@@ -680,7 +680,7 @@ public:
   /**
    *  @brief Write a block a n bytes
    *
-   *  May throw an exception if a write error occures.
+   *  May throw an exception if a write error occurs.
    *
    *  @param b What to write
    *  @param n The number of bytes to write 
@@ -847,7 +847,7 @@ private:
  *  This class mainly provides safety services for the file writer.
  *  When writing a file, it will keep a backup until the file actually
  *  has been written. This way, a network or disk full error will not
- *  comprimise the file's content. The backup file name is created
+ *  compromise the file's content. The backup file name is created
  *  by appending ".~backup" to the original file path.
  *
  *  In addition, a specified number or persistent backup files can

src/tl/tl/tlString.h

@@ -317,7 +317,7 @@ TL_PUBLIC std::string to_quoted_string (const std::string &s);
  *  @brief Escape special characters in a string
  *
  *  Special characters are replaced by escape sequences with a backslash.
- *  The format of the sequence is \xxx where x is the ocal number of the 
+ *  The format of the sequence is \xxx where x is the octal number of the 
  *  character and \r, \n and \t representing the CR, LF and TAB character.
  */
 TL_PUBLIC std::string escape_string (const std::string &value);
@@ -326,7 +326,7 @@ TL_PUBLIC std::string escape_string (const std::string &value);
  *  @brief Remove escape sequences from a string
  *
  *  Special characters are replaced by escape sequences with a backslash.
- *  The format of the sequence is \xxx where x is the ocal number of the 
+ *  The format of the sequence is \xxx where x is the octal number of the 
  *  character and \r, \n and \t representing the CR, LF and TAB character.
  */
 TL_PUBLIC std::string unescape_string (const std::string &value);
@@ -362,7 +362,7 @@ TL_PUBLIC std::string escaped_to_html (const std::string &in, bool replace_newli
 
 /**
  *  @brief Replaces the "before" string by "after" in the "subject" string and returns the new string
- *  All occurances are replaced.
+ *  All occurrences are replaced.
  */
 TL_PUBLIC std::string replaced (const std::string &subject, const std::string &before, const std::string &after);
 
@@ -458,7 +458,7 @@ public:
   /**
    *  @brief Read an unsigned integer
    *
-   *  A helper method to implement parsers on the chararacter-by-character basis.
+   *  A helper method to implement parsers on the character-by-character basis.
    *  This method reads an unsigned integer and returns the value past the last
    *  valid character. It skips blanks at the beginning but not at the end.
    *  On error, an exception is thrown.
@@ -713,7 +713,7 @@ public:
   /**
    *  @brief Skip blanks
    *
-   *  A helper method to implement parsers on the chararacter-by-character basis.
+   *  A helper method to implement parsers on the character-by-character basis.
    *  
    *  @param cp The current pointer (is being moved)
    *  @return The value of cp on return
@@ -921,7 +921,7 @@ TL_PUBLIC uint32_t utf32_upcase (uint32_t c32);
 /**
  *  @brief Parses the next UTF32 character from an UTF-8 string
  *  @param cp The input character's position, will be set to the next character.
- *  @paran cpe The end of the string of 0 for "no end"
+ *  @param cpe The end of the string of 0 for "no end"
  */
 TL_PUBLIC uint32_t utf32_from_utf8 (const char *&cp, const char *cpe = 0);
 

src/tl/tl/tlThreadedWorkers.h

@@ -125,7 +125,7 @@ private:
  *  @brief This object represents a job
  *
  *  A job can be delegated to multiple workers. 
- *  A job is organised in tasks, which are scheduled to the job. Upon \start,
+ *  A job is organized in tasks, which are scheduled to the job. Upon \start,
  *  the job takes the tasks from a queue and sends them to the workers for
  *  being processed.
  */
@@ -362,7 +362,7 @@ protected:
   /**
    *  @brief Perform one task
    *
-   *  The implementation of this method is supposed to regularily call \checkpoint in order to
+   *  The implementation of this method is supposed to regularly call \checkpoint in order to
    *  receive asynchronous abort requests. The scheduler uses this feature to stop operations
    *  asynchronously.
    */
@@ -371,7 +371,7 @@ protected:
   /**
    *  @brief Check for stop requests
    *
-   *  This method should be called regularily. It does nothing if no stop request if present. 
+   *  This method should be called regularly. It does nothing if no stop request if present. 
    *  Otherwise it throws an exception which is supposed to make \perform_task exit.
    */
   void checkpoint ();
@@ -506,7 +506,7 @@ public:
   }
 
   /**
-   *  @brief Send an aynchronous stop to all jobs registered at the Boss
+   *  @brief Send an asynchronous stop to all jobs registered at the Boss
    */
   void stop_all ();
 

src/tl/tl/tlUtils.h

@@ -195,7 +195,7 @@ private:
 };
 
 /**
- *  @brief A specialisation of assoc_map using a std::map as associative container
+ *  @brief A specialization of assoc_map using a std::map as associative container
  */
 template <class Value>
 struct map_map 
@@ -277,7 +277,7 @@ struct is_equal_type
 };
 
 /**
- *  @brief A type comparison operator (specialisation for equal classes)
+ *  @brief A type comparison operator (specialization for equal classes)
  */
 template <class A>
 struct is_equal_type<A, A>