acemod / language-arma-atom Goto Github PK

View Code? Open in Web Editor NEW

33.0 24.0 18.0 3.13 MB

Atom language support for Real Virtuality file formats

Home Page: https://atom.io/packages/language-arma-atom

License: MIT License

Python 41.13% CoffeeScript 23.26% JavaScript 35.61%

atom atom-package syntax-highlighting autocomplete snippet arma arma3

language-arma-atom's Introduction

Arma language support in Atom

This packages adds syntax highlighting and auto-completions for SQF files in Atom, including functions and macros from the CBA and ACE3 projects. This package is maintained and developed by the ACE3 development team and the Arma community effort.

Support for the following file types used by the Real Virtuality engine has been added:

Features

Syntax Highlighting

Syntax highlighting for all functions and script commands by Bohemia Interactive is supported. Next to that, functions and macros from CBA and ACE3 projects are also supported.

Autocomplete

With a goal of faster development in SQF, auto-completion for all BIS functions and script commands, as well as CBA and ACE3 functions and macros, is supported. All autocomplete assets also have a type, description and URL to their documentation.

CBA and ACE3 commands are optional, but enabled by default.

Snippets

Quick development also requires writing a lot of different blocks or combinations of code. A handful of useful snippets ranging from BIS conditional structures and loops through CBA macros and ACE3 function headers were added to help you with this.

CBA and ACE3 snippets are optional, but enabled by default.

Open Latest RPT File

Allows you to quickly open the latest Arma RPT log file with quick and easy access. Simply open the Command Palette and search for it or navigate to Packages -> Language Arma Atom -> Open Latest RPT File.

Build Project Tools

Only available if the project being worked on is based on a project framework like CBA's and ACE3's. The project must contain build.py and make.py tools.

To ease development when working on projects with a framework like CBA's or ACE3's, quick options for building the project directly from Atom is supported. You have the ability to build a development version or a full release, simply open the Command Palette and search for it or navigate to Packages -> Language Arma Atom -> Build Dev/Release.

Contributing

Contributions are greatly appreciated. You can help out with the ongoing development by looking for potential bugs in our code base, or by contributing new features. To contribute something to the Arma Language Package, simply fork this repository and submit your pull requests for review by other collaborators (see Contributing Guide).

Please, use our Issue Tracker to report a bug, propose a feature, or suggest changes to the existing ones.

language-arma-atom's People

Contributors

Stargazers

Watchers

Forkers

mikematrix simon84 cuel w4rgo shadez95 publicjorn dedmen vabene1111 theneo2k idbeholdl mijago shadowranger fieldgeneral1 jokoho48 jonbons seanpm2001

language-arma-atom's Issues

Add scope/patterns for different braces in SQF highlighting

Presumably something that would be done in:
https://github.com/acemod/language-arma-atom/blob/master/grammars/sqf.json

The {}, (), [] braces should be defined such that a user can style them independent of normal text (which they seemingly currently are).

missing command in

command in is missing in syntax Highlight

isEqualTo is a command, not an operator

https://github.com/acemod/language-arma-atom/blob/master/grammars/sqf.json#L44

Not really a bug, but I think it's better if isEqualTo would be under commands (syntax highlighting) as it makes the code more readable.

Add CONTRIBUTING.md

@Glowbal I believe you said you'll do this?

Separate language-sqf.json into multiple files

http://spacetelescope.github.io/understanding-json-schema/structuring.html

Failed to activate the language-arma-atom package

Highlighting editing.

Where should i add them to get some worlds highlighted as commands for example ?
(guies question general (not only to the package), but would really appreciate help)

#define autocompletition adds second #

Typing #def and then pressing tab to autocomplete results in ##define keyword value.

Update the maintenance scripts

I said I'd look into the scripts that retrieve SQF commands. My initial plan was to scrape the intercept pointers deceleration file the same way I did for the sqf repository (this is still an option as far as that is concerned). However I've realised that this package also reads the description and other information of each command so I'm in the process of checking why the scripts aren't working.

The first thing I notice is that armadoc.py only processes (alphabetically) up to curatorEditingArea.

Here is the information initially queried by the armadoc.py script. It seems that the code to continue requesting more information (I assume that's what this is meant to do) isn't working:

language-arma-atom/rsc/armadoc.py

Lines 18 to 22 in c4a6acf

 while 'query-continue' in content: 

 data = data + content['query']['categorymembers'] 

 params['cmcontinue'] = content['query-continue']['categorymembers']['cmcontinue'] 

 f = urllib.request.urlopen("https://community.bistudio.com/wikidata/api.php?%s" % urllib.parse.urlencode(params)) 

 content = json.loads(f.read().decode('utf-8'));

Language not setting correctly.

Language is defaulting to C++ in every arma format. Have to manually select language.

TextEditor.scrollToBottom is deprecated.

This is now a view method. Call TextEditorElement::scrollToTop instead.

TextEditor.scrollToBottom (<embedded>:5509:18)
<unknown> (C:\Users\bmxch\.atom\packages\language-arma-atom\lib\open-latest-rpt-file.coffee:32:17)

No code highlighting inside QUOTE macros

I am using QUOTE(code) for the onLoad scripts in ui configs. But its not highlighting any code words.
It should look like this:
https://github.com/CBATeam/CBA_A3/blob/master/addons/diagnostic/gui.hpp#L14 (Github highlighting does it correctly)
but it looks like this:

As you can see encasing the code in {} fixes it a little. But doesn't fix the QUOTE macro itself not highlighting.

Update README.md screenshots and information for autocomplete-plus

Screenshots with autocomplete-plus
Build and Open RPT functions shortly presented

Cannot find module 'copy-newer' Issue

Open Any File

Atom Version: 1.8.0
System: JOKOHO482
Thrown From: language-arma-atom package, v2.6.0

Stack Trace

Failed to activate the language-arma-atom package

At Cannot find module 'copy-newer'

Error: Cannot find module 'copy-newer'
    at Module._resolveFilename (module.js:338:15)
    at Function.Module._resolveFilename (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\module-cache.js:383:52)
    at Function.Module._load (module.js:289:25)
    at Module.require (module.js:366:17)
    at require (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\native-compile-cache.js:50:27)
    at Object.<anonymous> (file:///C:/Users/jokoho482/.atom/packages/language-arma-atom/index.coffee:2:13)
    at Object.<anonymous> (file:///C:/Users/jokoho482/.atom/packages/language-arma-atom/index.coffee:1:1)
    at Module._compile (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\native-compile-cache.js:103:30)
    at Object.defineProperty.value [as .coffee] (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\compile-cache.js:208:21)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:313:12)
    at Module.require (module.js:366:17)
    at require (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\native-compile-cache.js:50:27)
    at Package.module.exports.Package.requireMainModule (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\package.js:715:27)
    at Package.module.exports.Package.activateNow (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\package.js:173:16)
    at C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\package.js:841:28
    at Function.module.exports.Emitter.simpleDispatch (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\node_modules\event-kit\lib\emitter.js:25:14)
    at Emitter.module.exports.Emitter.emit (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\node_modules\event-kit\lib\emitter.js:125:28)
    at PackageManager.module.exports.PackageManager.triggerActivationHook (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\package-manager.js:573:43)
    at TokenizedBuffer.module.exports.TokenizedBuffer.setGrammar (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\tokenized-buffer.js:200:27)
    at TokenizedBuffer.module.exports.TokenizedBuffer.reloadGrammar (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\tokenized-buffer.js:211:21)
    at new TokenizedBuffer (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\tokenized-buffer.js:86:14)
    at new DisplayBuffer (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\display-buffer.js:91:32)
    at new TextEditor (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\text-editor.js:149:30)
    at Workspace.module.exports.Workspace.buildTextEditor (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\workspace.js:623:14)
    at Workspace.buildTextEditor (C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\workspace.js:60:52)
    at C:\Users\jokoho482\AppData\Local\atom\app-1.8.0\resources\app.asar\src\workspace.js:594:26
    at process._tickCallback (node.js:392:9)

Commands

     -1:36 tree-view:remove (ol.tree-view.full-menu.list-tree.has-collapsable-children.focusable-panel)
     -1:33.7.0 tree-view:add-file (span.name.icon.icon-file-directory)
     -1:31.5.0 core:cancel (atom-text-editor.editor.mini.is-focused)
     -1:28 tree-view:add-folder (div.header.list-item)
  3x -1:26.6.0 core:backspace (atom-text-editor.editor.mini.is-focused)
     -1:23.4.0 core:confirm (atom-text-editor.editor.mini.is-focused)
     -1:14.1.0 tree-view:add-file (span.name.icon.icon-file-directory)
     -1:09.2.0 core:backspace (atom-text-editor.editor.mini.is-focused)
     -1:07.2.0 core:confirm (atom-text-editor.editor.mini.is-focused)
     -0:58.9.0 core:select-all (atom-text-editor.editor.is-focused)
     -0:58.7.0 core:copy (atom-text-editor.editor.is-focused)
     -0:57.9.0 core:paste (atom-text-editor.editor.is-focused)
     -0:56.5.0 core:save (atom-text-editor.editor.is-focused)
     -0:53.6.0 tree-view:move (span.name.icon.icon-file-text)
     -0:52.8.0 editor:move-to-end-of-screen-line (atom-text-editor.editor.mini.is-focused)
     -0:50.3.0 core:confirm (atom-text-editor.editor.mini.is-focused)

Config

{
  "core": {
    "autoHideMenuBar": true,
    "disabledPackages": [
      "wrap-guide"
    ],
    "openEmptyEditorOnStart": false,
    "themes": [
      "atom-material-ui",
      "atom-material-syntax-dark"
    ]
  },
  "language-arma-atom": {
    "autocomplete": {}
  }
}

Installed Packages

# User
atom-material-syntax-dark, v0.2.5
atom-material-ui, v1.2.13
highlight-selected, v0.11.2
keyboard-localization, v1.4.18
language-arma-atom, v2.6.0
minimap, v4.24.7
minimap-bookmarks, v0.3.1
minimap-codeglance, v0.4.5
minimap-find-and-replace, v4.5.1
minimap-git-diff, v4.3.1
minimap-highlight-selected, v4.4.0
minimap-pigments, v0.2.1
minimap-selection, v4.4.0
project-plus, v0.9.0

# Dev
No dev packages

missing command diag_log

the diag_log command missing in the current master

Missing Magic Variable "paramsArray"

Missing Magic Variable paramsArray is missing in AutoComplet/Syntaxhighlight

this variable is often used in mission building

Loacal Variables starting with numbers don't autocomplete

if you use a variable like
_40mmGrenade = "AwsomeVar";
the syntax highlighter not register it

Incompatibility with atom-sublime-block-comment package

UltCombo/atom-sublime-block-comment#5
Can you please provide info: what comment scope descriptors is used in the language package?

Code Snipped If_exitWith Issue

If_exitWith missing chamber
Current Result:

if (CONDITION) exitwith {
    //code
;

Target Result:

if (CONDITION) exitwith {
    //code
};

code autocomplete doesnt work right

how it should look like:
https://i.gyazo.com/412e1599a952dd68ce41cc318183bff3.png

how i looks like:
https://i.gyazo.com/bc4ba1def4dcc82f12b600762ca3ffc6.png

the autocomplete-window doesnt show the right commands, just commands that have the same letters in them. example shows that the actual typed command is the last item in the list, even tho it should be first

Wrong definition for (Q)PATHTOEF

QPATHTOEF is defined as
#define QPATHTOEF(var1,var2) QUOTE(PATHTOEF(var1,var2))
but in atom it shows as the same as QPATHTOF which only has 1 arg.

QEGVAR is marked as an ACE3 macro

QEGVAR is marked as an ACE3 macro, but it's actually from CBA.

TextEditor.scrollToBottom is deprecated

This is now a view method. Call TextEditorElement::scrollToTop instead.

TextEditor.scrollToBottom (<embedded>:5427:18)
<unknown> (C:\Users\campb\.atom\packages\language-arma-atom\lib\open-latest-rpt-file.coffee:32:17)

Preprocessor definitions don't auto-complete

"#include",
"#define",
"#undef",
"#ifdef",
"#endif"

CBA_Settings functions missing

Function autocomplete/Info for CBA_Settings_* functions is missing.
For example CBA_Settings_init;

isEqualTo is a Operator but dont have a Color Coding

isEqualTo dont have a Color Coding but other isEqualX

Failed to load the Language-Arma Atom Package Settings

Receiving this error after recent update

Steps to reproduce

Start Atom With Language-Arma-Atom installed
Error should pop up

Atom Version: 1.9.8
System: Microsoft Windows 10 Pro
Thrown From: language-arma-atom package, v2.6.1

Stack Trace

Failed to load the language-arma-atom package settings

At C:\Users\dixon\.atom\packages\language-arma-atom\settings\language-sqf-native-commands.json: Unexpected end of input in C:\Users\dixon\.atom\packages\language-arma-atom\settings\language-sqf-native-commands.json

SyntaxError: C:\Users\dixon\.atom\packages\language-arma-atom\settings\language-sqf-native-commands.json: Unexpected end of input
    at Object.parse (native)
    at parseObject (C:\Users\dixon\AppData\Local\atom\app-1.9.8\resources\app.asar\node_modules\season\lib\cson.js:54:19)
    at parseContents (C:\Users\dixon\AppData\Local\atom\app-1.9.8\resources\app.asar\node_modules\season\lib\cson.js:102:16)
    at C:\Users\dixon\AppData\Local\atom\app-1.9.8\resources\app.asar\node_modules\season\lib\cson.js:204:20
    at tryToString (fs.js:414:3)
    at FSReqWrap.readFileAfterClose [as oncomplete] (fs.js:401:12)
  at C:\Users\dixon\.atom\packages\language-arma-atom\settings\language-sqf-native-commands.json:1:1

Commands

Config

{
  "core": {
    "disabledPackages": [
      "atom-django"
    ]
  }
}

Installed Packages

# User
django-atom, v0.2.4 (inactive)
django-templates, v0.5.0 (inactive)
language-arma-atom, v2.6.1 (inactive)
atom-dark-syntax, v0.27.0 (inactive)
atom-dark-ui, v0.51.0 (inactive)
atom-light-syntax, v0.28.0 (inactive)
atom-light-ui, v0.43.0 (inactive)
base16-tomorrow-dark-theme, v1.1.0 (inactive)
base16-tomorrow-light-theme, v1.1.1 (inactive)
one-dark-ui, v1.3.2 (active)
one-light-ui, v1.3.2 (inactive)
one-dark-syntax, v1.2.0 (active)
one-light-syntax, v1.2.0 (inactive)
solarized-dark-syntax, v1.0.2 (inactive)
solarized-light-syntax, v1.0.2 (inactive)
about, v1.5.2 (active)
archive-view, v0.61.1 (active)
autocomplete-atom-api, v0.10.0 (active)
autocomplete-css, v0.11.1 (active)
autocomplete-html, v0.7.2 (active)
autocomplete-plus, v2.31.0 (active)
autocomplete-snippets, v1.11.0 (active)
autoflow, v0.27.0 (inactive)
autosave, v0.23.1 (active)
background-tips, v0.26.0 (active)
bookmarks, v0.41.0 (active)
bracket-matcher, v0.82.1 (active)
command-palette, v0.38.0 (inactive)
deprecation-cop, v0.54.1 (active)
dev-live-reload, v0.47.0 (active)
encoding-selector, v0.22.0 (active)
exception-reporting, v0.39.0 (active)
fuzzy-finder, v1.3.0 (active)
git-diff, v1.1.0 (active)
find-and-replace, v0.198.0 (inactive)
go-to-line, v0.31.0 (inactive)
grammar-selector, v0.48.1 (active)
image-view, v0.58.0 (active)
incompatible-packages, v0.26.1 (active)
keybinding-resolver, v0.35.0 (active)
line-ending-selector, v0.5.0 (active)
link, v0.31.1 (inactive)
markdown-preview, v0.158.0 (active)
metrics, v0.53.1 (active)
notifications, v0.64.1 (active)
open-on-github, v1.2.0 (inactive)
package-generator, v1.0.0 (inactive)
settings-view, v0.238.2 (active)
snippets, v1.0.2 (active)
spell-check, v0.67.1 (active)
status-bar, v1.4.1 (active)
styleguide, v0.46.0 (active)
symbols-view, v0.113.0 (inactive)
tabs, v0.98.1 (active)
timecop, v0.33.1 (active)
tree-view, v0.208.0 (active)
update-package-dependencies, v0.10.0 (active)
welcome, v0.34.0 (active)
whitespace, v0.32.2 (active)
wrap-guide, v0.38.1 (active)
language-c, v0.52.1 (active)
language-clojure, v0.21.0 (active)
language-coffee-script, v0.47.0 (active)
language-csharp, v0.12.1 (active)
language-css, v0.36.2 (active)
language-gfm, v0.86.0 (active)
language-git, v0.13.0 (active)
language-go, v0.42.0 (active)
language-html, v0.44.1 (active)
language-hyperlink, v0.16.0 (active)
language-java, v0.22.0 (active)
language-javascript, v0.119.0 (active)
language-json, v0.18.0 (active)
language-less, v0.29.3 (active)
language-make, v0.22.2 (active)
language-mustache, v0.13.0 (active)
language-objective-c, v0.15.1 (active)
language-perl, v0.35.0 (active)
language-php, v0.37.0 (active)
language-property-list, v0.8.0 (active)
language-python, v0.45.0 (active)
language-ruby, v0.68.5 (active)
language-ruby-on-rails, v0.25.0 (active)
language-sass, v0.52.0 (active)
language-shellscript, v0.22.3 (active)
language-source, v0.9.0 (active)
language-sql, v0.21.1 (active)
language-text, v0.7.1 (active)
language-todo, v0.28.0 (active)
language-toml, v0.18.0 (active)
language-xml, v0.34.8 (active)
language-yaml, v0.26.0 (active)

# Dev
No dev packages

Missing command: ropeDetach

ropeDetach does not get highlighted correctly.
https://community.bistudio.com/wiki/ropeDetach

Classnames starting with numbers aren't highlighted

Take this bit of code :

class 30Rnd_556x45_Stanag {
    ...
};

The classname won't be colored, because it's starting with a number! I don't know if something can be done for this issue, but I'd love to see all my classes in the same color. It can be weird with files containing a large number of magazine classes.

Auto-completion for #include's

Like: https://github.com/nkt/atom-autocomplete-modules/
It's weird to not have auto-completion on #include when you have it on everything else.

Much code in one String doesn't show properly

Hey,
If I use this on an Arma script that has for example a big string like:

_bigstring = "
much here, like 100 lines or more
";
call compile _bigstring;

then you would see everything just in "green" as it is all part of "that" string :-/

Add BIS and CBA functions to new auto-completion

Required for 2.0.0.

BIS #40
CBA #27

Promise.done is deprecated.

Atom now uses ES6 Promises instead of Q. Call promise.then instead of promise.done

Promise.done (C:\Users\wmcri\AppData\Local\atom\app-1.16.0\resources\app.asar\src\atom-environment.js:1218:5)
Object.open (C:\Users\wmcri\.atom\packages\language-arma-atom\lib\open-latest-rpt-file.coffee:30:60)
atom-workspace.subscriptions.add.atom.commands.add.language-arma-atom:open-latest-RPT-file (C:\Users\wmcri\.atom\packages\language-arma-atom\index.coffee:79:38)
CommandRegistry.handleCommandEvent (C:\Users\wmcri\AppData\Local\atom\app-1.16.0\resources\app.asar\src\command-registry.js:259:29)
handleCommandEvent (C:\Users\wmcri\AppData\Local\atom\app-1.16.0\resources\app.asar\src\command-registry.js:3:59)
CommandRegistry.dispatch (C:\Users\wmcri\AppData\Local\atom\app-1.16.0\resources\app.asar\src\command-registry.js:160:19)

Syntax highlighting missing for isEqualTo

isEqualTo is defined as a comparison operator

language-arma-atom/grammars/sqf.json

Line 44 in 76d1b96

"match": "<=|>=|==|<|>|!=|isEqualTo"

Which makes it appear white. Which can cause oopsies like this

Toggle-line-comments doesn't activate that functionality despite the keybind being valid

I've run into an issue where Ctrl-/ shows as activating the editor:toggle-line-comments functionality, but nothing actually happens in the file. Rebinding this (to e.g. ctrl-i) doesn't change the behavior. This only occurs when the language-arma-atom module is active.

An example of the keybind resolver when I use the ctrl-/ bind:
https://i.gyazo.com/a159d9f5fe9f3ec0e75ed587a1175268.png

Request: Make ACE and CBA optional

Hi, I thought it'd be user-friendly to be able to "uncheck" ACE and CBA support from the package settings.
This way, for the average mission scripter (non-ace non-plugins) there would be less matches for the autocomplete and snippets functions in SQF scope.

I made a fork and tried to figure this out myself, but I bumped into 2 obstacles:

it seems "snippets" and "settings" (subfolders) are autmatically loaded
I can't find any documentation on the "settings" folder being auto-loaded (assuming this is Provider-API functionality).

I have this outstanding question on stackoverflow, to see if it's at all possible to exclude snippet files from the snippet folder. Or maybe some of you already know how this can be done..

Arma config: String doesn't close if last character is backslash

Related to the backslash character causing following letters in config strings to be highlighted, if the last character in a string is a backslash (e.g. "Something\fnord") the string highlighting won't end until the next quote mark in the file.

Picture

Add SQF Specs

Figure out why the grammar is not being loaded for the specs #56
Write the specs

Verify which macros are ACE3's and which CBA's

Currently it's not correct.

	while 'query-continue' in content:
	data = data + content['query']['categorymembers']
	params['cmcontinue'] = content['query-continue']['categorymembers']['cmcontinue']
	f = urllib.request.urlopen("https://community.bistudio.com/wikidata/api.php?%s" % urllib.parse.urlencode(params))
	content = json.loads(f.read().decode('utf-8'));

acemod / language-arma-atom Goto Github PK

language-arma-atom's Introduction

Arma language support in Atom

Features

Syntax Highlighting

Autocomplete

Snippets

Open Latest RPT File

Build Project Tools

Contributing

language-arma-atom's People

Contributors

Stargazers

Watchers

Forkers

language-arma-atom's Issues

Stack Trace

Commands

Config

Installed Packages

Steps to reproduce

Stack Trace

Commands

Config

Installed Packages

Recommend Projects

Recommend Topics

Recommend Org