[nvda-addons] commit/switchSynth: norrumar: Initial commit.
- From: commits-noreply@xxxxxxxxxxxxx
- To: nvda-addons@xxxxxxxxxxxxx
- Date: Mon, 05 Aug 2013 20:55:40 -0000
1 new commit in switchSynth:
https://bitbucket.org/nvdaaddonteam/switchsynth/commits/8f2d67500956/
Changeset: 8f2d67500956
Branch: master
User: norrumar
Date: 2013-08-05 22:54:01
Summary: Initial commit.
Affected #: 11 files
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..ceae4de
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,2 @@
+# Set default behaviour, in case users don't have core.autocrlf set.
+* text=auto
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6d124be
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,10 @@
+addon/doc/*.css
+addon/doc/en/
+*_docHandler.py
+*.html
+*.ini
+*.mo
+*.pot
+*.pyc
+*.nvda-addon
+.sconsign.dblite
diff --git a/COPYING.txt b/COPYING.txt
new file mode 100644
index 0000000..623b625
--- /dev/null
+++ b/COPYING.txt
@@ -0,0 +1,340 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year><name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
diff --git a/addon/globalPlugins/switchSynth.py
b/addon/globalPlugins/switchSynth.py
new file mode 100644
index 0000000..e2f0bd6
--- /dev/null
+++ b/addon/globalPlugins/switchSynth.py
@@ -0,0 +1,56 @@
+import cPickle
+import os
+import config
+import globalPluginHandler
+import speech
+import ui
+
+class GlobalPlugin(globalPluginHandler.GlobalPlugin):
+
+ def __init__(self, *args, **kwargs):
+ super(GlobalPlugin, self).__init__(*args, **kwargs)
+ self.synths = {}
+ self.slot = 1
+ self.load()
+
+ def script_setSynth(self, gesture):
+ self.slot = slot = int(gesture.displayName[-1])
+ if slot in self.synths:
+ config.conf['speech'][self.synths[slot]['name']].clear()
+
config.conf['speech'][self.synths[slot]['name']].update(self.synths[slot]['config'])
+ speech.setSynth(self.synths[slot]['name'])
+ speech.getSynth().saveSettings()
+ ui.message(str(slot))
+ script_setSynth.__doc__ = _("Sets the currently active synthesizer to
the selected slot.")
+
+ def script_saveSynth(self, gesture):
+ if self.slot not in self.synths:
+ self.synths[self.slot] = {}
+ self.synths[self.slot]['name'] = speech.getSynth().name
+ self.synths[self.slot]['config'] =
dict(config.conf['speech'][speech.getSynth().name])
+ self.write()
+ ui.message(_("saved"))
+ script_saveSynth.__doc__ = _("Save the currently used synthesizer and
its settings to the currently selected slot")
+
+ def write(self):
+ path = os.path.join(config.getUserDefaultConfigPath(),
"switch_synth.pickle")
+ with open(path, 'wb') as f:
+ cPickle.dump(self.synths, f)
+
+ def load(self):
+ path = os.path.join(config.getUserDefaultConfigPath(),
"switch_synth.pickle")
+ if not os.path.exists(path): return
+ with open(path, 'rb') as f:
+ self.synths = cPickle.load(f)
+ if 'version' not in self.synths:
+ self.synths = {'version': 1}
+
+ __gestures = {
+ "kb:control+NVDA+1": "setSynth",
+ "kb:control+NVDA+2": "setSynth",
+ "kb:control+NVDA+3": "setSynth",
+ "kb:control+NVDA+4": "setSynth",
+ "kb:control+NVDA+5": "setSynth",
+ "kb:control+NVDA+6": "setSynth",
+ "kb:control+shift+NVDA+v":"saveSynth",
+}
diff --git a/buildVars.py b/buildVars.py
new file mode 100644
index 0000000..a487573
--- /dev/null
+++ b/buildVars.py
@@ -0,0 +1,44 @@
+# -*- coding: UTF-8 -*-
+
+# Build customizations
+# Change this file instead of sconstruct or manifest files, whenever possible.
+
+# Full getext (please don't change)
+_ = lambda x : x
+
+# Add-on information variables
+addon_info = {
+ # for previously unpublished addons, please follow the community
guidelines at:
+ #
https://bitbucket.org/nvdaaddonteam/todo/src/56140dbec531e4d7591338e1dbc6192f3dd422a8/guideLines.txt
+ # add-on Name, internal for nvda
+ "addon-name" : "switchSynth",
+ # Add-on summary, usually the user visible name of the addon.
+ # TRANSLATORS: Summary for this add-on to be shown on installation and
add-on information.
+ "addon-summary" : _("Switch synth"),
+ # Add-on description
+ # Translators: Long description to be shown for this add-on on add-on
information from add-ons manager
+ "addon-description" : _("""Allows easy switching between synthesizers.
+To switch synthesizers, press control+NVDA+1 through control+NVDA+6.
+To save the current voice in the currently selected slot, press
control+shift+NVDA+v."""
+ ),
+ # version
+ "addon-version" : "1.0-dev",
+ # Author(s)
+ "addon-author" : "Tyler Spivey <tspivey@xxxxxxxxxx>",
+ # URL for the add-on documentation support
+ "addon-url" : None
+}
+
+
+import os.path
+
+# Define the python files that are the sources of your add-on.
+# You can use glob expressions here, they will be expanded.
+pythonSources = ["addon/globalPlugins/switchSynth.py"]
+
+# Files that contain strings for translation. Usually your python sources
+i18nSources = pythonSources + ["buildVars.py", "docHandler.py"]
+
+# Files that will be ignored when building the nvda-addon file
+# Paths are relative to the addon directory, not to the root directory of your
addon sources.
+excludedFiles = []
diff --git a/docHandler.py b/docHandler.py
new file mode 100644
index 0000000..8dde60e
--- /dev/null
+++ b/docHandler.py
@@ -0,0 +1,68 @@
+# -*- coding: UTF-8 -*-
+
+# docHandler: module for managing addons documentation
+# See: http://community.nvda-project.org/ticket/2694
+
+import os
+import languageHandler
+import addonHandler
+import globalPluginHandler
+import gui
+import wx
+
+addonHandler.initTranslation()
+
+_addonDir = os.path.join(os.path.dirname(__file__), "..") # The root of an
addon folder
+_docFileName = "readme.html" # The name of an addon documentation file
+_curAddon = addonHandler.Addon(_addonDir) # Addon instance
+_addonSummary = _curAddon.manifest['summary']
+_addonVersion = _curAddon.manifest['version']
+_addonName = _curAddon.manifest['name']
+
+def getDocFolder(addonDir=_addonDir):
+ langs = [languageHandler.getLanguage(), "en"]
+ for lang in langs:
+ docFolder = os.path.join(addonDir, "doc", lang)
+ if os.path.isdir(docFolder):
+ return docFolder
+ if "_" in lang:
+ tryLang = lang.split("_")[0]
+ docFolder = os.path.join(addonDir, "doc", tryLang)
+ if os.path.isdir(docFolder):
+ return docFolder
+ if tryLang == "en":
+ break
+ if lang == "en":
+ break
+ return None
+
+def getDocPath(docFileName=_docFileName):
+ docPath = getDocFolder()
+ if docPath is not None:
+ docFile = os.path.join(docPath, docFileName)
+ if os.path.isfile(docFile):
+ docPath = docFile
+ return docPath
+
+def openDocPath():
+ try:
+ os.startfile(getDocPath())
+ except WindowsError:
+ pass
+
+class GlobalPlugin(globalPluginHandler.GlobalPlugin):
+
+ def __init__(self):
+ super(globalPluginHandler.GlobalPlugin, self).__init__()
+ self.help = gui.mainFrame.sysTrayIcon.helpMenu
+ self.helpItem = self.help.Append(wx.ID_ANY, "{summary}
{version}".format(summary=_addonSummary, version=_addonVersion), _addonName)
+ gui.mainFrame.sysTrayIcon.Bind(wx.EVT_MENU, self.onHelp,
self.helpItem)
+
+ def onHelp(self, evt):
+ openDocPath()
+
+ def terminate(self):
+ try:
+ self.help.RemoveItem(self.helpItem)
+ except wx.PyDeadObjectError:
+ pass
diff --git a/manifest-translated.ini.tpl b/manifest-translated.ini.tpl
new file mode 100644
index 0000000..4750635
--- /dev/null
+++ b/manifest-translated.ini.tpl
@@ -0,0 +1,2 @@
+summary = "{addon-summary}"
+description = """{addon-description}"""
diff --git a/manifest.ini.tpl b/manifest.ini.tpl
new file mode 100644
index 0000000..8093a3f
--- /dev/null
+++ b/manifest.ini.tpl
@@ -0,0 +1,6 @@
+name = {addon-name}
+summary = "{addon-summary}"
+description = """{addon-description}"""
+author = "{addon-author}"
+url = {addon-url}
+version = {addon-version}
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..44d5538
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,9 @@
+# Switch synth #
+
+This addon allows easy switching of synthesizers via hotkeys.
+It is an improved version of my earlier switch_synth addon with an underscore,
which must be uninstalled. Any preexisting synthesizer configurations will
continue to work with this version.
+
+There are 6 synthesizer slots, 1 through 6. By default, they are empty.
+Slots can be switched by pressing control+NVDA+1 through control+NVDA+6.
+Once a slot is switched to, its synthesizer and settings will be loaded if
they exist.
+To save the current synthesizer and its settings to the currently active slot,
press control+shift+NVDA+v.
diff --git a/sconstruct b/sconstruct
new file mode 100644
index 0000000..aa65448
--- /dev/null
+++ b/sconstruct
@@ -0,0 +1,188 @@
+# NVDA add-on template SCONSTRUCT file
+#Copyright (C) 2012 Rui Batista <ruiandrebatista@xxxxxxxxx>
+#This file is covered by the GNU General Public License.
+#See the file COPYING.txt for more details.
+
+import codecs
+import gettext
+import shutil
+import os
+import os.path
+import zipfile
+import markdown
+import configobj
+
+import buildVars
+
+
+def md2html(source, dest):
+ lang = os.path.basename(os.path.dirname(source)).replace('_', '-')
+ title="{addonSummary}
{addonVersion}".format(addonSummary=buildVars.addon_info["addon-summary"],
addonVersion=buildVars.addon_info["addon-version"])
+ headerDic = {
+ "[[!meta title=\"": "# ",
+ "\"]]": " #",
+ }
+ with codecs.open(source, "r", "utf-8") as f:
+ mdText = f.read()
+ for k, v in headerDic.iteritems():
+ mdText = mdText.replace(k, v, 1)
+ htmlText = markdown.markdown(mdText)
+ with codecs.open(dest, "w", "utf-8") as f:
+ f.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
+ "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0
Strict//EN\"\n" +
+ "
\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\";>\n" +
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\";
xml:lang=\"%s\" lang=\"%s\">\n" % (lang, lang) +
+ "<head>\n" +
+ "<meta http-equiv=\"Content-Type\" content=\"text/html;
charset=UTF-8\"/>\n" +
+ "<link rel=\"stylesheet\" type=\"text/css\"
href=\"../style.css\" media=\"screen\"/>\n" +
+ "<title>%s</title>\n" % title +
+ "</head>\n<body>\n"
+ )
+ f.write(htmlText)
+ f.write("\n</body>\n</html>")
+
+def mdTool(env):
+ mdAction=env.Action(
+ lambda target,source,env: md2html(source[0].path,
target[0].path),
+ lambda target,source,env: 'Generating %s'%target[0],
+ )
+ mdBuilder=env.Builder(
+ action=mdAction,
+ suffix='.html',
+ src_suffix='.md',
+ )
+ env['BUILDERS']['markdown']=mdBuilder
+
+env = Environment(ENV=os.environ, tools=[mdTool])
+
+
+addonFile =
env.File("{addon-name}-{addon-version}.nvda-addon".format(**buildVars.addon_info))
+
+def addonGenerator(target, source, env, for_signature):
+ action = env.Action(lambda target, source, env :
createAddonBundleFromPath(source[0].abspath, target[0].abspath) and None,
+ lambda target, source, env : "Generating Addon %s" % target[0])
+ return action
+
+def manifestGenerator(target, source, env, for_signature):
+ action = env.Action(lambda target, source, env :
generateManifest(source[0].abspath, target[0].abspath) and None,
+ lambda target, source, env : "Generating manifest %s" % target[0])
+ return action
+
+
+def translatedManifestGenerator(target, source, env, for_signature):
+ dir = os.path.abspath(os.path.join(os.path.dirname(str(source[0])),
".."))
+ lang = os.path.basename(dir)
+ action = env.Action(lambda target, source, env :
generateTranslatedManifest(source[1].abspath, lang, target[0].abspath) and None,
+ lambda target, source, env : "Generating translated manifest %s" %
target[0])
+ return action
+
+env['BUILDERS']['NVDAAddon'] = Builder(generator=addonGenerator)
+env['BUILDERS']['NVDAManifest'] = Builder(generator=manifestGenerator)
+env['BUILDERS']['NVDATranslatedManifest'] =
Builder(generator=translatedManifestGenerator)
+
+env['BUILDERS']['gettextMoFile']=env.Builder(
+ action=env.Action(["msgfmt -o $TARGETS $SOURCES"], lambda t, s, e :
"Compiling translation %s" % s[0]),
+ suffix=".mo",
+ src_suffix=".po"
+)
+
+env['BUILDERS']['gettextPotFile']=env.Builder(
+ action=env.Action(["xgettext --msgid-bugs-address='%s'
--package-name='%s' --package-version='%s' -c -o $TARGETS $SOURCES" %
+ ("nvda-translations@xxxxxxxxxxxxx",
buildVars.addon_info['addon-name'], buildVars.addon_info['addon-version'])
+ ], lambda t, s, e : "Generating pot file %s" % t[0]),
+ suffix=".pot")
+env['BUILDERS']['gettextMergePotFile']=env.Builder(
+ action=env.Action(["xgettext --msgid-bugs-address='%s'
--package-name='%s' --package-version='%s' --omit-header --no-location -c -o
$TARGETS $SOURCES" %
+ ("nvda-translations@xxxxxxxxxxxxx",
buildVars.addon_info['addon-name'], buildVars.addon_info['addon-version'])
+ ], lambda t, s, e : "Generating pot file %s" % t[0]),
+ suffix=".pot")
+
+def createAddonHelp(dir):
+ if not os.path.isfile("readme.md") or not
os.path.isfile("docHandler.py"):
+ return
+ docdirs = [os.path.join(dir, "doc"), os.path.join(dir, "doc", "en")]
+ for docdir in docdirs:
+ if not os.path.isdir(docdir):
+ os.makedirs(docdir)
+ if os.path.isfile("style.css"):
+ shutil.copy("style.css", docdirs[0])
+ shutil.copyfile("readme.md", os.path.join(docdir, "readme.md"))
+ plugindir = os.path.join(dir, "globalPlugins")
+ docFilename =
"{addonName}_docHandler.py".format(addonName=buildVars.addon_info["addon-name"])
+ docPath = os.path.join(plugindir, docFilename)
+ if not os.path.isdir(plugindir):
+ os.makedirs(plugindir)
+ shutil.copyfile("docHandler.py", docPath)
+
+def createAddonBundleFromPath(path, dest):
+ """ Creates a bundle from a directory that contains an addon manifest
file."""
+ basedir = os.path.abspath(path)
+ with zipfile.ZipFile(dest, 'w', zipfile.ZIP_DEFLATED) as z:
+ # FIXME: the include/exclude feature may or may not be useful.
Also python files can be pre-compiled.
+ for dir, dirnames, filenames in os.walk(basedir):
+ relativePath = os.path.relpath(dir, basedir)
+ for filename in filenames:
+ pathInBundle = os.path.join(relativePath,
filename)
+ absPath = os.path.join(dir, filename)
+ if pathInBundle not in buildVars.excludedFiles:
z.write(absPath, pathInBundle)
+ return dest
+
+def generateManifest(source, dest):
+ with codecs.open(source, "r", "utf-8") as f:
+ manifest_template = f.read()
+ manifest = manifest_template.format(**buildVars.addon_info)
+ with codecs.open(dest, "w", "utf-8") as f:
+ f.write(manifest)
+
+def generateTranslatedManifest(source, language, out):
+ _ = gettext.translation("nvda", localedir=os.path.join("addon",
"locale"), languages=[language]).ugettext
+ vars = {}
+ for var in ("addon-summary", "addon-description"):
+ vars[var] = _(buildVars.addon_info[var])
+ with codecs.open(source, "r", "utf-8") as f:
+ manifest_template = f.read()
+ result = manifest_template.format(**vars)
+ with codecs.open(out, "w", "utf-8") as f:
+ f.write(result)
+
+def expandGlobs(files):
+ return [f for pattern in files for f in env.Glob(pattern)]
+
+addon = env.NVDAAddon(addonFile, env.Dir('addon'))
+
+langDirs = [f for f in env.Glob(os.path.join("addon", "locale", "*"))]
+
+#Allow all NVDA's gettext po files to be compiled in source/locale, and
manifest files to be generated
+for dir in langDirs:
+ poFile = dir.File(os.path.join("LC_MESSAGES", "nvda.po"))
+ moFile=env.gettextMoFile(poFile)
+ env.Depends(moFile, poFile)
+ translatedManifest =
env.NVDATranslatedManifest(dir.File("manifest.ini"), [moFile,
os.path.join("manifest-translated.ini.tpl")])
+ env.Depends(translatedManifest, ["buildVars.py"])
+ env.Depends(addon, [translatedManifest, moFile])
+
+pythonFiles = expandGlobs(buildVars.pythonSources)
+for file in pythonFiles:
+ env.Depends(addon, file)
+
+#Convert markdown files to html
+createAddonHelp("addon") # We need at least doc in English and should append
an item to Help menu
+for mdFile in env.Glob(os.path.join('addon', 'doc', '*', '*.md')):
+ htmlFile = env.markdown(mdFile)
+ env.Depends(htmlFile, mdFile)
+ env.Depends(addon, htmlFile)
+
+# Pot target
+i18nFiles = expandGlobs(buildVars.i18nSources)
+pot = env.gettextPotFile("%s.pot" %
"{addon-name}".format(**buildVars.addon_info), i18nFiles)
+env.Alias('pot', pot)
+env.Depends(pot, i18nFiles)
+mergePot = env.gettextMergePotFile("%s-merge.pot" %
"{addon-name}".format(**buildVars.addon_info), i18nFiles)
+env.Alias('mergePot', mergePot)
+env.Depends(mergePot, i18nFiles)
+
+# Generate Manifest path
+manifest = env.NVDAManifest(os.path.join("addon", "manifest.ini"),
os.path.join("manifest.ini.tpl"))
+
+env.Depends(addon, manifest)
+env.Default(addon)
diff --git a/style.css b/style.css
new file mode 100644
index 0000000..373283f
--- /dev/null
+++ b/style.css
@@ -0,0 +1,30 @@
+@charset "utf-8";
+body {
+font-family : Verdana, Arial, Helvetica, Sans-serif;
+color : #FFFFFF;
+background-color : #000000;
+line-height: 1.2em;
+}
+h1, h2 {text-align: center}
+dt {
+font-weight : bold;
+float : left;
+width: 10%;
+clear: left
+}
+dd {
+margin : 0 0 0.4em 0;
+float : left;
+width: 90%;
+display: block;
+}
+p { clear : both;
+}
+a { text-decoration : underline;
+}
+:active {
+text-decoration : none;
+}
+a:focus, a:hover {outline: solid}
+:link {color: #0000FF;
+background-color: #FFFFFF}
Repository URL: https://bitbucket.org/nvdaaddonteam/switchsynth/
--
This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.
----------------------------------------------------------------
NVDA add-ons Central: A list for discussing NVDA add-ons
To post a message, send an email to nvda-addons@xxxxxxxxxxxxx.
To unsubscribe, send an email with the subject line of "unsubscribe" (without
quotes) to nvda-addons-request@xxxxxxxxxxxxx.
If you have questions for list moderators, please send a message to
nvda-addons-moderators@xxxxxxxxxxxxx.
Community addons can be found here: http://addons.nvda-project.org
Other related posts:
- » [nvda-addons] commit/switchSynth: norrumar: Initial commit. - commits-noreply
