AccuTerm Client for Sublime Text
AccuTermClient
AccuTerm client is a plugin for Sublime Text allows you to connect to a MultiValue server using AccuTerm. This plugin allows for
source code editing and compiling on remote MV servers as well as executing commands and using the native data conversion processing codes (OCONV/ICONV).
Features
Standard Features
These features will work with all MV DBMS that support Accuterm.
-
Download & upload files
-
Compile source code
-
Lock/Unlock items on the MultiValue server
-
Iconv/Oconv from Sublime
-
Run currently open file
-
Execute commands on the MV Server and display output in Sublime
-
Global case change while preserving case in comments & strings
Extended Features
These features require DBMS specific configuration to run. D3, QM, and jBASE are configured automatically. Additional DBMS can be setup manually (see the Settings section below).
-
Prev/Next compile error
-
Browse command stack
-
Browse files on MV server (jBASE Windows not supported)
Requirements
-
Sublime Text 3
-
PyWin32 Sublime Package
-
Windows Operating System
-
AccuTerm terminal emulator running the FTSERVER program
Installation
Using Sublime Package Manager
-
Package Control: Install
-
AccuTermClient
Using Github
-
cd %appdata%\Sublime Text 3\Packages
-
git clone https://github.com/ianharper/AccuTermClient.git
-
Install the PyWin32 Sublime package.
Usage
This package connects to your MV database using AccuTerm's FTSERVER program. To use, launch AccuTerm and run FTSERVER from TCL. AccuTermClient will connect to the AccuTerm server with no additional configuration.
This package expects that all files on your local machine to be contained in a folder that matches the file on the MV server. Files will be named on your local machine with a ".bp" suffix. When uploaded to the MV server this suffix will be removed.
Example: C:\code\BP\HELLO.WORLD.bp will be uploaded to BP HELLO.WORLD in the account that FTSERVER is running in.
Commands
-
Open - Download item from MV server by entering MV file reference. Will lock item on MV server if open_with_readu setting is true.
-
Open (Read Only) - Download item from MV sever without locking by entering MV file reference.
-
Upload - Upload current file to MV server.
-
Compile - Compile Current file on MV server.
-
Release - Release lock of current file on MV server.
-
Release All - Release all locks held by current user on MV server.
-
Unlock - unlock item on MV server by entering MV file reference.
-
Refresh - Update currently open file in Sublime from MV server and lock item on MV server.
-
Check Sync (Current File) - Compare the currently open file to the item on the MV server. If the item on the MV server is different than the local file you will be asked if you want to download the changes from the MV server.
-
List - Browse files on MV server using Sublime's command palate, select item with enter to download.
-
Lock - Lock item on MV server by entering MV file reference.
-
Execute - Run commands on MV server and show output in Sublime (to console, new file, or append to current file).
-
Run - Run the currently open file. If the item is in the MD/VOC then the item name will be used to run (enables running PROC, PARAGRAPH, or MACRO commands).
-
Iconv/Oconv - Convert data using the MV server's iconv/oconv functions.
-
Global Upcase - Convert case of currently open file to uppercase while preserving case in strings and comments.
-
Global Downcase - Convert case of currently open file to lowercase while preserving case in strings and comments.
Settings
The settings can be accessed in the Preferences>Package Settings>AccuTermClient>Settings. The settings are in json format. Each top level key-value pair will be explained below. Some settings are specific to the MV DBMS, they will have a second key that specifies the DBMS. This key for your DBMS can be found in ACCUTERM,ACCUTERMCTRL, KMTCFG<51>. These settings can be set for general editing in Sublime or for specific Sublime projects.
-
multivalue_syntaxes List of MV syntaxes. Referenced to determine if a file in Sublime is MultiValue.
-
default_save_location Location to save MV files by default. When editing a file in a Sublime project the project folder will be used instead.
-
remove_file_extensions File extensions to remove when uploading to the MV server.
-
compile_command Command to execute when the Sublime Build command is run.
-
open_with_readu Lock files on MV server when opening.
-
result_line_regex Regular expression used to find the line number of compile errors. See exec Target Options in the Sublime Docs for details.
-
list_files_command Command to list all the files in the account. Used in the AccuTermClient List command. The output must contain only the file name, one per line.
-
list_command This command is run after a file is chosen from the List command. The value is appended to a "SORT (filename) " command to limit the output to only the item names.
-
syntax_file_locations List of MV syntaxes to apply after downloading. The default values come from the MultiValue Basic Sublime package
-
command_history MV file and item for the command stack.
Custom Commands
Custom commands can be easily added from Preferences>Package Settings>AccuTermClient>Custom Commands. When added these commands will be shown in Sublime's command palate. The syntax for these commands follows Sublime's command syntax which is in JSON format (with comments).
Example:
[
{
// Name the command
"caption": "Term - Disable page breaks",
// Set the Sublime command to run
"command": "accu_term_execute",
// Set the command to run on the MV server and where to show the output (console, new, append, or replace).
"args": { "command": "TERM 150,0", "output_to": "console"}
}
]
Todo
-
Add support for jBASE windows.
-
Set MV syntax automatically based on DBMS type and file contents (ex. PQ in line 1 should set PROC).
-
Allow file extensions to be set based on DBMS type and file contents (ex. PQ in line 1 should set proc ext.).
