true
false
cargo doc | Builds package documentation.
Clippy | cargo clippy | Runs [Clippy](https://github.com/Manishearth/rust-clippy). Clippy must be installed, and currently requires the nightly toolchain.
Script | cargo script $path | Runs [Cargo Script](https://github.com/DanielKeep/cargo-script). Cargo Script must be installed. This is an addon that allows you to run a Rust source file like a script (without a Cargo.toml manifest).
-## General Settings
-
-General settings (see [Settings](../README.md#settings)) for how messages are displayed are:
-
-| Setting | Default | Description |
-| :------ | :------ | :---------- |
-| `rust_syntax_hide_warnings` | `false` | If true, will not display warning messages. |
-| `rust_syntax_error_color` | `"var(--redish)"` | Color of error messages. |
-| `rust_syntax_warning_color` | `"var(--yellowish)"` | Color of warning messages. |
-| `rust_syntax_note_color` | `"var(--greenish)"` | Color of note messages. |
-| `rust_syntax_help_color` | `"var(--bluish)"` | Color of help messages. |
-| `rust_phantom_style` | `"normal"` | How to display inline messages. Either `normal`, `popup`, or `none`. |
-| `rust_region_style` | `"outline"` | How to highlight messages. Either `outline` or `none`. |
-| `rust_gutter_style` | `"shape"` | Type of icon to show in the gutter. Either `shape`, `circle`, or `none`. |
-
-It also supports Sublime's build settings:
-
-| Setting | Default | Description |
-| :------ | :------ | :---------- |
-| `show_errors_inline` | `true` | If true, messages are displayed in line using Sublime's phantoms. If false, messages are only displayed in the output panel. |
-| `show_panel_on_build` | `true` | If true, an output panel is displayed at the bottom of the window showing the compiler output. |
-
## Cargo Settings
A variety of settings are available to customize how Cargo is run. These
diff --git a/docs/img/messages_popup.gif b/docs/img/messages_popup.gif
new file mode 100644
index 00000000..585871b9
Binary files /dev/null and b/docs/img/messages_popup.gif differ
diff --git a/docs/img/region_style_none.png b/docs/img/region_style_none.png
new file mode 100644
index 00000000..35063747
Binary files /dev/null and b/docs/img/region_style_none.png differ
diff --git a/docs/img/region_style_outline.png b/docs/img/region_style_outline.png
new file mode 100644
index 00000000..3d7e16f9
Binary files /dev/null and b/docs/img/region_style_outline.png differ
diff --git a/docs/img/show_errors_inline_false.png b/docs/img/show_errors_inline_false.png
new file mode 100644
index 00000000..46df5b1f
Binary files /dev/null and b/docs/img/show_errors_inline_false.png differ
diff --git a/docs/img/show_errors_inline_true.png b/docs/img/show_errors_inline_true.png
new file mode 100644
index 00000000..80af1561
Binary files /dev/null and b/docs/img/show_errors_inline_true.png differ
diff --git a/docs/img/theme_clear.png b/docs/img/theme_clear.png
new file mode 100644
index 00000000..7dd47950
Binary files /dev/null and b/docs/img/theme_clear.png differ
diff --git a/docs/img/theme_solid.png b/docs/img/theme_solid.png
new file mode 100644
index 00000000..ea5c043a
Binary files /dev/null and b/docs/img/theme_solid.png differ
diff --git a/docs/messages.md b/docs/messages.md
new file mode 100644
index 00000000..32b2f3c8
--- /dev/null
+++ b/docs/messages.md
@@ -0,0 +1,107 @@
+# Messages
+
+There are a variety of ways to display Rust compiler messages. See
+[Settings](../README.md#settings) for more details about how to configure
+settings.
+
+## Inline Phantoms vs Output Panel
+
+The `show_errors_inline` setting controls whether or not errors are shown
+inline with the code using Sublime's "phantoms". If it is `true`, it will
+also display an abbreviated message in the output panel. If it is `false`,
+messages will only be displayed in the output panel, using rustc's formatting.
+
+### `show_errors_inline`
+
+true |
+ |
+
false |
+ |
+
+
+## Phantom Themes
+
+The style of the phantom messages is controlled with the `rust_message_theme`
+setting. Currently the following themes are available:
+
+### `rust_message_theme`
+
+clear |
+  |
+
solid |
+  |
+
| Regions are highlighted with an outline. |
+| `none` | 
| Regions are not highlighted. |
+
+## Gutter Images
+
+The gutter (beside the line numbers) will include an icon indicating the level
+of the message. The styling of these icons is controlled with
+`rust_gutter_style`.
+
+### `rust_gutter_style`
+
+| Value | Description |
+| :---- | :---------- |
+| `shape` | 
|
+| `circle` | 
|
+| `none` | Do not display icons. |
+
+## Other Settings
+
+A few other settings are available for controlling messages:
+
+| Setting | Default | Description |
+| :------ | :------ | :---------- |
+| `show_panel_on_build` | `true` | If true, an output panel is displayed at the bottom of the window showing the compiler output. |
+| `rust_syntax_hide_warnings` | `false` | If true, will not display warning messages. |
diff --git a/images/gutter/circle-none.png b/images/gutter/circle-none.png
new file mode 100644
index 00000000..67672cbb
Binary files /dev/null and b/images/gutter/circle-none.png differ
diff --git a/images/gutter/circle-none@2x.png b/images/gutter/circle-none@2x.png
new file mode 100644
index 00000000..c9c07057
Binary files /dev/null and b/images/gutter/circle-none@2x.png differ
diff --git a/images/gutter/shape-none.png b/images/gutter/shape-none.png
new file mode 100644
index 00000000..67672cbb
Binary files /dev/null and b/images/gutter/shape-none.png differ
diff --git a/images/gutter/shape-none@2x.png b/images/gutter/shape-none@2x.png
new file mode 100644
index 00000000..c9c07057
Binary files /dev/null and b/images/gutter/shape-none@2x.png differ
diff --git a/messages.json b/messages.json
new file mode 100644
index 00000000..4935d67d
--- /dev/null
+++ b/messages.json
@@ -0,0 +1,3 @@
+{
+ "2.11.0": "changelog/2.11.0.md"
+}
diff --git a/rust/batch.py b/rust/batch.py
new file mode 100644
index 00000000..9e60da6d
--- /dev/null
+++ b/rust/batch.py
@@ -0,0 +1,118 @@
+"""Classes used for aggregating messages that are on the same line."""
+
+
+class MessageBatch:
+
+ """Abstract base class for a set of messages that apply to the same line.
+
+ :ivar children: List of additional messages, may be empty.
+ :ivar hidden: Boolean if this message should be displayed.
+ """
+
+ hidden = False
+
+ def __init__(self):
+ self.children = []
+
+ def __iter__(self):
+ """Iterates over all messages in the batch."""
+ raise NotImplementedError()
+
+ def path(self):
+ """Returns the file path of the batch."""
+ raise NotImplementedError()
+
+ def first(self):
+ """Returns the first message of the batch."""
+ raise NotImplementedError()
+
+ def dismiss(self):
+ """Permanently remove this message and all its children from the
+ view."""
+ raise NotImplementedError()
+
+ def _dismiss(self, window):
+ # There is a awkward problem with Sublime and
+ # add_regions/erase_regions. The regions are part of the undo stack,
+ # which means even after we erase them, they can come back from the
+ # dead if the user hits undo. We simply mark these as "hidden" to
+ # ensure that `clear_messages` can erase any of these zombie regions.
+ # See https://github.com/SublimeTextIssues/Core/issues/1121
+ # This is imperfect, since the user could do the following:
+ # 1) Build 2) Type some text 3) Clear Messages 4) Undo
+ # which will resurrect the regions without an easy way to remove them
+ # (user has to close and reopen the file). I don't know of any good
+ # workarounds.
+ for msg in self:
+ view = window.find_open_file(msg.path)
+ if view:
+ view.erase_regions(msg.region_key)
+ view.erase_phantoms(msg.region_key)
+
+
+class PrimaryBatch(MessageBatch):
+
+ """A batch of messages with the primary message.
+
+ :ivar primary_message: The primary message object.
+ :ivar child_batches: List of `ChildBatch` batches associated with this
+ batch.
+ :ivar child_links: List of `(url, text)` tuples for links to child batches
+ that are "far away".
+ """
+
+ primary_message = None
+
+ def __init__(self, primary_message):
+ super(PrimaryBatch, self).__init__()
+ self.primary_message = primary_message
+ self.child_batches = []
+ self.child_links = []
+
+ def __iter__(self):
+ yield self.primary_message
+ for child in self.children:
+ yield child
+
+ def path(self):
+ return self.primary_message.path
+
+ def first(self):
+ return self.primary_message
+
+ def dismiss(self, window):
+ self.hidden = True
+ self._dismiss(window)
+ for batch in self.child_batches:
+ batch._dismiss(window)
+
+
+class ChildBatch(MessageBatch):
+
+ """A batch of messages that are associated with a primary message.
+
+ :ivar primary_batch: The `PrimaryBatch` this is associated with.
+ :ivar back_link: Tuple of `(url, text)` of the link to the primary batch
+ if it is "far away" (otherwise None).
+ """
+
+ primary_batch = None
+ back_link = None
+
+ def __init__(self, primary_batch):
+ super(ChildBatch, self).__init__()
+ self.primary_batch = primary_batch
+
+ def __iter__(self):
+ for child in self.children:
+ yield child
+
+ def path(self):
+ return self.children[0].path
+
+ def first(self):
+ return self.children[0]
+
+ def dismiss(self, window):
+ self.hidden = True
+ self.primary_batch.dismiss(window)
diff --git a/rust/messages.py b/rust/messages.py
index aa2e2163..1a5b928c 100644
--- a/rust/messages.py
+++ b/rust/messages.py
@@ -8,155 +8,173 @@
import itertools
import os
import re
+import urllib.parse
+import uuid
import webbrowser
-from . import util
+from . import util, themes
+from .batch import *
# Key is window id.
# Value is a dictionary: {
-# 'paths': {path: [msg_dict,...]},
-# 'msg_index': (path_idx, message_idx)
+# 'paths': {path: [MessageBatch, ...]},
+# 'batch_index': (path_idx, message_idx),
# }
+# `paths` is an OrderedDict to handle next/prev message.
# `path` is the absolute path to the file.
-# Each msg_dict has the following:
-# - `level`: Message level as a string such as "error", or "info".
-# - `span`: Location of the message (0-based):
-# `((line_start, col_start), (line_end, col_end))`
-# May be `None` to indicate no particular spot.
-# - `is_main`: If True, this is a top-level message. False is used for
-# attached detailed diagnostic information, child notes, etc.
-# - `path`: Absolute path to the file.
-# - `text`: The raw text of the message without any minihtml markup. May be
-# None if the content is raw markup.
-# - `minihtml_text`: The string used for showing phantoms that includes the
-# minihtml markup.
-# - `output_panel_region`: Optional Sublime Region object that indicates the
-# region in the build output panel that corresponds with this message.
WINDOW_MESSAGES = {}
LINK_PATTERN = r'(https?://[-a-zA-Z0-9@:%._+~#=]{2,256}\.[a-zA-Z]{2,6}\b[-a-zA-Z0-9@:%_+.~#?&/=]*)'
-CSS_TEMPLATE = """
-
-
-{content}
-
-"""
-
-POPUP_CSS = """
- body {
- margin: 0.25em;
- }
-"""
-
-
-def clear_messages(window):
- WINDOW_MESSAGES.pop(window.id(), None)
- for view in window.views():
- view.erase_phantoms('rust-syntax-phantom')
- view.erase_regions('rust-error')
- view.erase_regions('rust-warning')
- view.erase_regions('rust-note')
- view.erase_regions('rust-help')
+class Message:
+ """A diagnostic message.
-def add_message(window, path, span, level, is_main, text, minihtml_text, msg_cb):
- """Add a message to be displayed.
-
- :param window: The Sublime window.
- :param path: The absolute path of the file to show the message for.
- :param span: Location of the message (0-based):
+ :ivar id: A unique uuid for this message.
+ :ivar region_key: A string for the Sublime highlight region and phantom
+ for this message. Unique per view.
+ :ivar text: The raw text of the message without any minihtml markup. May
+ be None if the content is raw markup (such as a minihtml link) or if
+ it is an outline-only region (which happens with things such as
+ dual-region messages added in 1.21).
+ :ivar minihtml_text: The string used for showing phantoms that includes
+ the minihtml markup. May be None.
+ :ivar level: Message level as a string such as "error", or "info".
+ :ivar span: Location of the message (0-based):
`((line_start, col_start), (line_end, col_end))`
May be `None` to indicate no particular spot.
- :param level: The Rust message level ('error', 'note', etc.).
- :param is_main: If True, this is a top-level message. False is used for
- attached detailed diagnostic information, child notes, etc.
- :param text: The raw text of the message without any minihtml markup. May
- be None if there is no text (such as when adding pure markup).
- :param minihtml_text: The message to display with minihtml markup.
- :param msg_cb: Callback that will be given the message. May be None.
+ :ivar path: Absolute path to the file.
+ :ivar code: Rust error code as a string such as 'E0001'. May be None.
+ :ivar output_panel_region: Optional Sublime Region object that indicates
+ the region in the build output panel that corresponds with this
+ message.
+ :ivar primary: True if this is the primary message, False if a child.
+ :ivar children: List of additional Message objects. This is *not*
+ recursive (children cannot have children).
+ :ivar parent: The primary Message object if this a child.
"""
- if 'macros>' in path:
- # Macros from external crates will be displayed in the console
- # via msg_cb.
- return
- wid = window.id()
- try:
- messages_by_path = WINDOW_MESSAGES[wid]['paths']
- except KeyError:
- # This is an OrderedDict to handle next/prev message.
- messages_by_path = collections.OrderedDict()
- WINDOW_MESSAGES[wid] = {
- 'paths': messages_by_path,
- 'msg_index': (-1, -1)
- }
- messages = messages_by_path.setdefault(path, [])
-
- to_add = {
- 'path': path,
- 'level': level,
- 'span': span,
- 'is_main': is_main,
- 'text': text,
- 'minihtml_text': minihtml_text,
- }
- if _is_duplicate(to_add, messages):
- # Don't add duplicates.
- return
- messages.append(to_add)
- view = window.find_open_file(path)
- if view:
- _show_phantom(view, level, span, minihtml_text)
- if msg_cb:
- msg_cb(to_add)
-
-
-def _is_duplicate(to_add, messages):
- # Ignore 'minihtml_text' and 'output_panel_region' keys.
- keys = ('path', 'span', 'is_main', 'level', 'text')
- for message in messages:
+ region_key = None
+ text = None
+ minihtml_text = None
+ level = None
+ span = None
+ path = None
+ code = None
+ output_panel_region = None
+ primary = True
+ parent = None
+
+ def __init__(self):
+ self.id = uuid.uuid4()
+ self.children = []
+
+ def lineno(self, first=False):
+ """Return the line number of the message (0-based).
+
+ :param first: If True, returns the line number of the start of the
+ region. Otherwise returns the last line of the region.
+ """
+ if self.span:
+ if first:
+ return self.span[0][0]
+ else:
+ return self.span[1][0]
+ else:
+ return 999999999
+
+ def __iter__(self):
+ """Convenience iterator for iterating over the message and its children."""
+ yield self
+ for child in self.children:
+ yield child
+
+ def escaped_text(self, indent):
+ """Returns the minihtml markup of the message.
+
+ :param indent: String used for indentation when the message spans
+ multiple lines. Typically a series of to get correct
+ alignment.
+ """
+ if self.minihtml_text:
+ return self.minihtml_text
+ if not self.text:
+ return ''
+
+ def escape_and_link(i_txt):
+ i, txt = i_txt
+ if i % 2:
+ return '%s' % (txt, txt)
+ else:
+ # Call strip() because sometimes rust includes newlines at the
+ # end of the message, which we don't want.
+ escaped = html.escape(txt.strip(), quote=False)
+ return re.sub('^( +)', lambda m: ' '*len(m.group()), escaped, flags=re.MULTILINE)\
+ .replace('\n', '