Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix for issue #1070 - Autocomplete for \cite{} and \ref{} looks in open buffers too #1071

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 29 additions & 7 deletions latex_cite_completions.py
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,22 @@ def _find_bib_files():
return cache.LocalCache(root).cache('bib_files', _find_bib_files)


def find_open_bib_files(active_window_only=False):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer that the default option was to search the active window only since its possible to have multiple unrelated TeX documents open at the same time.

# get list of windows we want to check for valid buffers
if active_window_only:
windows = [sublime.active_window()]
else:
windows = sublime.windows()

# find which buffers are .bib files
result = []
for window in windows:
result += [v.file_name() for v in window.views() if (v.file_name() or '').endswith('.bib')]

# remove duplicates
return list(set(result))


def run_plugin_command(command, *args, **kwargs):
'''
This function is intended to run a command against a user-configurable list
Expand Down Expand Up @@ -389,13 +405,19 @@ def get_cite_completions(view):

if root is None:
# This is an unnamed, unsaved file
# FIXME: should probably search the buffer instead of giving up
raise NoBibFilesError()

print(u"TEX root: " + repr(root))
bib_files = find_bib_files(root)
print("Bib files found: ")
print(repr(bib_files))
bib_files = None
else:
print(u"TEX root: " + repr(root))
bib_files = find_bib_files(root)
print("Bib files found: ")
print(repr(bib_files))

if not bib_files:
# Check the open files, in case the current file is TEX root,
# but doesn't reference anything
bib_files = find_open_bib_files()
print("Open Bib files found: ")
print(repr(bib_files))

if not bib_files:
# sublime.error_message("No bib files found!") # here we can!
Expand Down
17 changes: 16 additions & 1 deletion latex_ref_completions.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,29 @@ def find_labels_in_files(root, labels):
labels.append(command.args)


# grab labels from all open buffers too
def find_labels_in_open_files(views, labels):
for view in views:
# XXX: Hardcoded to only look for tex files, so that it doesn't try
# looking for label commands in support files
if view.file_name() is None or view.file_name().endswith(".tex"):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could probably be more sensibly implemented by checking the syntax (something like view.score_selector('text.tex.latex', 0) > 0 or at least checking for various extensions supported using the is_tex_file() function in the latextools_utils.is_tex_file module.

view.find_all(r'\\label\{([^\{\}]+)\}', 0, '\\1', labels)


# get_ref_completions forms the guts of the parsing shared by both the
# autocomplete plugin and the quick panel command
def get_ref_completions(view):
completions = []
# Check the file buffer first:
# 1) in case there are unsaved changes
# 2) if this file is unnamed and unsaved, get_tex_root will fail
view.find_all(r'\\label\{([^\{\}]+)\}', 0, '\\1', completions)
find_labels_in_open_files([view], completions)

# Check all other open buffers too:
# 1) for the same reasons as above
# 2) in case the project isn't set up to build in Sublime
for window in sublime.windows():
find_labels_in_open_files(window.views(), completions)

root = getTeXRoot.get_tex_root(view)
if root:
Expand Down