Merge branch 'release/v2.1.0'

Author: gepd

CHANGES.md

@@ -1,4 +1,35 @@
 # Deviot Release Notes
+
+## Version 2.1.0 | 14 Aug 2017
+
+#### New
+* Text history in the "Send" Serial Monitor input panel (Issue: https://github.com/gepd/Deviot/issues/84)
+* Deviot fala Portugues (Thanks to Alexandre Fernandes)
+* Experimental feature to avoid wrong line number with ino files
+
+#### Improvements
+* Show a progress bar when the PlatformIO terminal is used
+* Updated caption for "Clean Monitor" to avoid confusion when the quick panel use
+* Updated shortcuts to avoid override sublime text hot keys in Linux and OSX (Issue: https://github.com/gepd/Deviot/issues/132)
+* QuickPanel shorcut will be the same in all platforms (ctrl+alt+q)
+* Rebuild the syntax file after add/remove an extra library folder
+* Highlight improvements
+* Changed the setup settings to a new file to make the plugin compatible with the sync plugin(s). This change will allow to exclude the deviot.ini file locate in Package/User/Deviot in the sync plugin (Issue: https://github.com/gepd/Deviot/issues/127)
+* Bring back the persistence in the "send" input text (Issue: https://github.com/gepd/Deviot/issues/135)
+* Improved the way to implement the phantom (create and hide)
+
+#### Bugs
+* Avoid to stop the message queue after use the first command in the platformIO terminal
+* Search libraries in the extra library folder if it's set
+* Show the list of examples instead of "Import Library" list
+* Some Linux distro and OSX versions are not working well, when "pio" command is use. "plaformio" will be used instead.
+* Make sure the serial port is in use before to remove it
+* Check the last action when not IOT file is in the buffer
+* When PlatformIO is already installed and accessible. The command won't be modified (Issue: https://github.com/gepd/Deviot/issues/133)
+* Check and replace the old syntax file after load the plugin (Issue: https://github.com/gepd/Deviot/issues/133)
+* Make sure to get the extension of the file in buffer (Issue: https://github.com/gepd/Deviot/issues/139)
+* Force to initialize the sketch even if it already exitst in the temp folder when "Use PlatformIO Structure" is activated. The 'src_dir' flag will be add before compile/upload the sketch and removed after the task is finished (issue: https://github.com/gepd/Deviot/issues/137)
+
 ## Version 2.0.1 | 03 Jul 2017
 * Improvement Syntax is created even if the PlatformIO setup fails (Issue: https://github.com/gepd/Deviot/issues/125)
 * Improvement Force Sublime Text to assign deviot syntax when it's a IOT file (Issue: https://github.com/gepd/Deviot/issues/125)

Deviot.py

@@ -7,18 +7,27 @@
 from __future__ import unicode_literals
 
 from os import path
+from sublime import windows
 from sublime_plugin import EventListener
 
 from .commands import *
 from .platformio.update import Update
 from .beginning.pio_install import PioInstall
-from .libraries.tools import get_setting, save_setting, get_phantoms, del_phantom, set_deviot_syntax
-from .libraries.paths import getBoardsFileDataPath, getMainMenuPath
+from .libraries.tools import get_setting, save_setting, set_deviot_syntax
+from .libraries.paths import getBoardsFileDataPath, getMainMenuPath, getPluginPath
 from .libraries.preferences_bridge import PreferencesBridge
 from .libraries.project_check import ProjectCheck
 
 def plugin_loaded():
+    # Load or fix the right deviot syntax file 
+    for window in windows():
+        for view in window.views():
+            set_deviot_syntax(view)
+
+    # Install PlatformIO
     PioInstall()
+
+    # Search updates
     Update().check_update_async()
 
     menu_path = getMainMenuPath()
@@ -29,6 +38,14 @@ def plugin_loaded():
         TopMenu().make_menu_files()
         save_setting('compile_lang', False)
 
+    # check if the syntax file exist
+    deviot_syntax = getPluginPath()
+    syntax_path = path.join(deviot_syntax, 'deviot.sublime-syntax')
+
+    if(not path.exists(syntax_path)):
+        active_window().run_command('deviot_rebuild_syntax')
+
+
 class DeviotListener(EventListener):
     def on_load(self, view):
         set_deviot_syntax(view)
@@ -46,25 +63,4 @@ def on_close(self, view):
             port_id = search_id[1]
             serial_monitor = serial.serial_monitor_dict.get(port_id, None)
             serial_monitor.stop()
-            del serial.serial_monitor_dict[port_id]
-
-    def on_modified(self, view):
-        """On modify file
-        
-        checks the phantoms in the current view and remove it
-        when it's neccesary
-        
-        Arguments:
-            view {obj} -- sublime text object
-        """
-        is_iot = ProjectCheck().is_iot()
-        phantoms = get_phantoms()
-
-        if(not len(phantoms) and not is_iot):
-            return
-
-        line, column = view.rowcol(view.sel()[0].begin())
-        pname = 'error' + str(line + 1)
-
-        if(pname in phantoms and view.file_name()):
-            del_phantom(pname)
+            del serial.serial_monitor_dict[port_id]

beginning/pio_install.py

@@ -42,6 +42,8 @@
 ###
 from ..libraries.syntax import Syntax
 from ..libraries.tools import get_setting, save_setting
+from ..libraries.tools import get_sysetting, save_sysetting
+from ..libraries.paths import getSystemIniPath
 from ..libraries.thread_progress import ThreadProgress
 from ..libraries.I18n import I18n
 from ..platformio.pio_bridge import PioBridge
@@ -59,9 +61,13 @@ def __init__(self, window=False):
         self.sub_ver = sublime.version()
 
         ###
-        installed = get_setting('installed', False)
+        installed = get_sysetting('installed', False)
+        if(not installed):
+            found = self.check_old_settings()
+            if(found):
+                return
 
-        if(installed):
+        if(bool(installed)):
             return
 
         Syntax()
@@ -77,6 +83,27 @@ def __init__(self, window=False):
         thread.start()
         ThreadProgress(thread, caption, '')
 
+    def check_old_settings(self):
+        """
+        All the dynamic settings are being stored in the 
+        deviot.ini file instead of the deviot.sublime-settings.
+        To avoid make the user remove all the preferences and
+        run the setup process again, this function will move the
+        preferences automatically
+        """
+        found = False
+        settings = ['env_path', 'symlink', 'external_bins', 'last_check_update',
+                    'last_action', 'installed']
+
+        for setting in settings:
+            current = get_setting(setting)
+            if(current):
+                save_sysetting(setting, current)
+                save_setting(setting)
+                found = True
+
+        return found
+
     def file_paths(self):
         """ Set Initial Values
 
@@ -165,7 +192,7 @@ def install(self):
         env_path = [self.V_ENV_PATH, self.V_ENV_BIN_PATH]
         save_env_paths(env_path)
 
-        save_setting('installed', True)
+        save_sysetting('installed', True)
         PioBridge().save_boards_list()
 
         derror("setup_finished")
@@ -219,7 +246,7 @@ def check_sym_link(self):
             dprint("symlink_detected")
             self.version = sub(r'\D', '', out[1])
             self.SYMLINK = 'python2'
-            save_setting('symlink', True)
+            save_sysetting('symlink', True)
 
     def check_python(self):
         """Python requirement
@@ -256,16 +283,16 @@ def check_pio():
 
     Check if platformIO is already installed in the machine
     """
-    cmd = ['pio', '--version']
+    cmd = ['platformio', '--version']
     out = run_command(cmd)
 
     status = out[0]
 
     if(status is 0):
         env_path = get_env_paths()
-        save_setting('installed', True)
-        save_setting('external_bins', True)
-        save_setting('env_path', env_path)
+        save_sysetting('installed', True)
+        save_sysetting('external_bins', True)
+        save_sysetting('env_path', env_path)
         PioBridge().save_boards_list()
         derror("pio_is_installed")
 
@@ -339,7 +366,7 @@ def save_env_paths(new_path):
     paths = list(OrderedDict.fromkeys(paths))
     paths = path.pathsep.join(paths)
 
-    save_setting('env_path', paths)
+    save_sysetting('env_path', paths)
 
 
 def get_default_paths():

commands/__init__.py

@@ -25,6 +25,7 @@
 from .deviot_toggle_serial_monitor import DeviotToggleSerialMonitorCommand
 from .deviot_send_serial_monitor import DeviotSendSerialMonitorCommand
 from .deviot_output_console import DeviotOutputConsoleCommand
+from .deviot_send_persistent import DeviotSendPersistentCommand
 from .deviot_automatic_scroll import DeviotAutomaticScrollCommand
 from .deviot_auto_clean import DeviotAutoCleanCommand
 from .deviot_choose_baudrate import DeviotChooseBaudrateCommand
@@ -49,6 +50,7 @@
 from .deviot_clean_console import DeviotCleanConsoleCommand
 from .deviot_reload import DeviotReloadCommand
 from .deviot_set_ip import DeviotSetIpCommand
+from .deviot_history import InputTextHistoryCommand
 
 __all__ = [
     'DeviotNewSketchCommand',
@@ -77,6 +79,7 @@
     'DeviotSetPasswordCommand',
     'DeviotToggleSerialMonitorCommand',
     'DeviotSendSerialMonitorCommand',
+    'DeviotSendPersistentCommand',
     'DeviotOutputConsoleCommand',
     'DeviotStatusInformationCommand',
     'DeviotAutomaticScrollCommand',
@@ -101,5 +104,6 @@
     'DeviotCleanViewCommand',
     'DeviotCleanConsoleCommand',
     'DeviotReloadCommand',
-    'DeviotSetIpCommand'
+    'DeviotSetIpCommand',
+    'InputTextHistoryCommand'
 ]

commands/deviot_extra_library_folder.py

@@ -8,4 +8,8 @@ class DeviotExtraLibraryFolderCommand(WindowCommand):
     """
 
     def run(self):
-        folder_explorer(key='extra_library', callback=save_setting)
+        folder_explorer(key='extra_library', callback=self.done)
+
+    def done(self, key, value):
+        save_setting(key, value)
+        self.window.run_command('deviot_rebuild_syntax')

commands/deviot_history.py

@@ -0,0 +1,64 @@
+"""
+Copyright (c) 2015 Randy Lai <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from sublime import Region
+from sublime_plugin import TextCommand
+
+
+class History:
+    hist = []
+    index = None
+
+    def insert(self, user_input):
+        if not self.hist or (user_input != self.last() and user_input != "last_regex"):
+            self.hist.append(user_input)
+            self.index = None
+
+    def roll(self, backwards=False):
+        if self.index is None:
+            self.index = -1 if backwards else 0
+        else:
+            self.index += -1 if backwards else 1
+
+        if self.index == len(self.hist) or self.index < -len(self.hist):
+            self.index = -1 if backwards else 0
+
+    def last(self):
+        return self.hist[-1] if self.hist else None
+
+    def get(self, index=None):
+        if not index:
+            index = self.index
+        return self.hist[index] if self.hist else None
+
+    def reset_index(self):
+        self.index = None
+
+if 'history' not in globals():
+    history = History()
+
+
+class InputTextHistoryCommand(TextCommand):
+    def run(self, edit, backwards=False):
+        history.roll(backwards)
+        self.view.erase(edit, Region(0, self.view.size()))
+        self.view.insert(edit, 0, history.get())

commands/deviot_pio_structure.py

@@ -1,5 +1,6 @@
 from sublime_plugin import WindowCommand
 from ..libraries.tools import get_setting, save_setting
+from ..libraries.project_check import ProjectCheck
 
 class DeviotPioStructureCommand(WindowCommand):
     """

commands/deviot_remove_extra_library_folder.py

@@ -9,6 +9,7 @@ class DeviotRemoveExtraLibraryFolderCommand(WindowCommand):
 
     def run(self):
         save_setting('extra_library', None)
+        self.window.run_command('deviot_rebuild_syntax')
 
     def is_enabled(self):
         extra = get_setting('extra_library', None)

commands/deviot_send_persistent.py

@@ -0,0 +1,19 @@
+from sublime_plugin import WindowCommand
+from ..libraries.tools import get_setting, save_setting
+
+class DeviotSendPersistentCommand(WindowCommand):
+    """
+    Sets the input text for the serial communication, persistent,
+    this means; after send a text, the input text will be displayed
+    until press the esc key
+
+    Extends: sublime_plugin.WindowCommand
+    """
+
+    def run(self):
+        send_persistent = get_setting('send_persistent', True)
+        save_setting('send_persistent', not send_persistent)
+
+
+    def is_checked(self):
+        return get_setting('send_persistent', True)

commands/deviot_send_serial_monitor.py

@@ -1,22 +1,29 @@
-from sublime_plugin import WindowCommand
+from sublime_plugin import TextCommand
 from ..libraries import serial
 from ..libraries.tools import get_setting
+from .deviot_history import history
 
-class DeviotSendSerialMonitorCommand(WindowCommand):
+class DeviotSendSerialMonitorCommand(TextCommand):
     text_send = None
     output_console = None
+    window = None
 
-    def run(self):
+    def run(self, edit):
+        self.window = self.view.window()
         caption = 'send'
-        self.window.show_input_panel(caption, '', self.on_done, None, self.on_cancel)
+        v = self.window.show_input_panel(caption, '', self.on_done, None, self.on_cancel)
+        v.settings().set('deviotInputText', True)
 
     def on_done(self, text):
+        history.insert(text)
         self.text_send(text)
+        self.window.run_command('deviot_send_serial_monitor')
 
         if(self.output_console):
             self.window.run_command('deviot_show_console')
 
     def on_cancel(self):
+        history.reset_index()
         if(self.output_console):
             self.window.run_command('deviot_show_console')