Prevent interference with other signs

.gitignore

@@ -0,0 +1,4 @@
+tags
+*.sw[op]
+__pycache__
+doc/tags

README.rst

@@ -1,31 +1,117 @@
-vim-pudb
-========
+vim-pudb-and-jam
+================
+
+A simple plugin allowing you to manage pudb breakpoints directly from vim.
+Forked from `vim-pudb`_ and given some jammy features such as setting and
+editing breakpoint conditions, customization options, improved persistence
+of breakpoints, and the ability to list active breakpoints either as a
+printed message or in a quickfix list.
 
-simple plugin allowing you to manage pudb breakpoint directly into vim.
+.. _vim-pudb: https://github.com/KangOl/vim-pudb
 
-This plugin need vim to be compiled with +python
 
 Installation
 ============
 
-The recommended way of installing is to use `vim-pathogen`_
+Similar to any other vim plugin, use your preferred method. If you're new, check
+out
+`vim-pathogen <https://github.com/tpope/vim-pathogen#readme>`_ or
+`vim-plug <https://github.com/junegunn/vim-plug>`_ or
+`:help packages <https://vimhelp.org/repeat.txt.html#packages>`_
+
+
+Requirements
+------------
 
+This plugin needs vim to be compiled with ``+python`` or ``+python3`` as well as
+``+signs`` and is intended for vim 8.2 or later, though I'm not sure exactly
+which patch is the earliest that is supported.
 
-How to use
-==========
-To add/remove a breakpoint, you just need to call the command ``:TogglePudbBreakPoint``
+You will also need to have `pudb`_ installed, obviously.
+
+.. _pudb: https://pypi.org/project/pudb/
+
+
+Commands
+========
 
-For easy access, you can bind it to the F8 key.
+``:PudbToggle``
+    Add / remove a breakpoint at the current line.
 
+``:PudbEdit``
+    Edit the condition of a breakpoint on the current line. Creates a
+    breakpoint if one doesn't already exist.
 
-    ``nnoremap <F8> :TogglePudbBreakPoint<CR>``
+``:PudbClearAll``
+    Remove all breakpoints from every file.
 
-    ``inoremap <F8> <ESC>:TogglePudbBreakPoint<CR>a``
+``:PudbList``
+    Show a list of the full file paths, line numbers, and conditions of all
+    breakpoints.
 
-.. _vim-pathogen: https://github.com/tpope/vim-pathogen#readme
+``:PudbLocList``
+    Load all breakpoints into the location list. Does not jump to the first
+    entry.
+
+``:PudbQfList``
+    Load all breakpoints into the quickfix list. Does not jump to the first
+    entry.
+
+``:PudbPopulateList <arg>``
+    Supply a list of all breakpoints, in quickfix format, to the Ex command
+    given by <arg>. This is a generic form of PudbLocList and PudbQfList,
+    allowing you to customise the operation for any precise need you may have.
+
+``:PudbUpdate``
+    Sometimes the breakpoint signs can get out of date. The above commands will
+    all trigger an update, but this command lets you trigger an update without
+    doing anything else.
+
+    NOTE: There should no longer be any need to call this command. Breakpoint
+    signs are updated whenever you save the buffer.
+
+
+Mappings
+========
 
-Know problems
+There are no mappings set up by default, so you don't have to worry about
+conflicts with other plugins. Here's what I use:
+
+::
+
+    nnoremap <leader>bc :<C-U>PudbClearAll<CR>
+    nnoremap <leader>be :<C-U>PudbEdit<CR>
+    nnoremap <leader>bl :<C-U>PudbList<CR>
+    nnoremap <leader>bq :<C-U>PudbQfList<CR>
+    nnoremap <leader>bp :<C-U>PudbToggle<CR>
+    nnoremap <leader>bu :<C-U>PudbUpdate<CR>
+
+
+Configuration
 =============
-Currently, the list of breakpoints is not reloaded automatically. 
 
-There is also room for speed optimisations.
+The text of the sign can be defined with ``g:pudb_sign`` (default ``'B>'``):
+
+``let g:pudb_sign = 'B>'``
+
+The highlight group of the sign in the sign column can be defined with
+``g:pudb_highlight`` (default ``'error'``):
+
+``let g:pudb_highlight = 'error'``
+
+The priority of the breakpoint signs can be defined with ``g:pudb_priority``
+(default ``100``):
+
+``let g:pudb_priority = 100``
+
+This plugin uses sign groups. You can change the name of the sign group using
+``g:pudb_sign_group`` (default ``pudb_sign_group``):
+
+``let g:pudb_sign_group = 'pudb_sign_group'``
+
+
+Known problems
+==============
+
+- There may be room for speed optimisations.
+- There is currently no way to specify which breakpoint file to use.

doc/vim-pudb-and-jam.txt

@@ -0,0 +1,186 @@
+*vim-pudb-and-jam.txt*  Manage pudb breakpoints directly from vim
+
+Author: Michael van der Kamp
+License: Same terms as vim itself (see |license|)
+
+Forked from vim-pudb: https://github.com/KangOl/vim-pudb
+
+
+==============================================================================
+CONTENTS                                        *vim-pudb-contents* *vim-pudb*
+                                                *vim-pudb-and-jam*
+
+    1. Introduction ........................... |vim-pudb-introduction|
+    2. Installation ........................... |vim-pudb-installation|
+    3. Requirements ........................... |vim-pudb-requirements|
+    4. Commands ............................... |vim-pudb-commands|
+        4.1 PudbToggle ........................ |vim-pudb-:PudbToggle|
+        4.2 PudbEdit .......................... |vim-pudb-:PudbEdit|
+        4.2 PudbMove .......................... |vim-pudb-:PudbMove|
+        4.3 PudbClearAll ...................... |vim-pudb-:PudbClearAll|
+        4.4 PudbList .......................... |vim-pudb-:PudbList|
+        4.5 PudbLocList ....................... |vim-pudb-:PudbLocList|
+        4.6 PudbQfList ........................ |vim-pudb-:PudbQfList|
+        4.7 PudbPopulateList .................. |vim-pudb-:PudbPopulateList|
+        4.8 PudbUpdate ........................ |vim-pudb-:PudbUpdate|
+        4.8 PudbEditFile ...................... |vim-pudb-:PudbEditFile|
+    5. Configuration .......................... |vim-pudb-configuration|
+        5.1 vim-pudb-sign ..................... |vim-pudb-sign|
+        5.2 vim-pudb-sign-group ............... |vim-pudb-sign-group|
+        5.3 vim-pudb-highlight ................ |vim-pudb-highlight|
+        5.4 vim-pudb-priority ................. |vim-pudb-priority|
+    6. Known problems ......................... |vim-pudb-known-problems|
+
+
+==============================================================================
+INTRODUCTION                                    *vim-pudb-introduction*
+
+This plugin allows you to:
+
+    * Toggle pudb breakpoints
+    * Edit and view pudb breakpoints
+    * List pudb breakpoints
+    * Load pudb breakpoints into the quickfix list
+
+There are no mappings set up by default, so you don't have to worry about
+conflicts with other plugins. Here are some recommended mappings though,
+to add to your `.vimrc` file:
+>
+    nnoremap <leader>bc :<C-U>PudbClearAll<CR>
+    nnoremap <leader>be :<C-U>PudbEdit<CR>
+    nnoremap <leader>bm :<C-U>PudbMove<CR>
+    nnoremap <leader>bl :<C-U>PudbList<CR>
+    nnoremap <leader>bq :<C-U>PudbQfList<CR>
+    nnoremap <leader>bp :<C-U>PudbToggle<CR>
+    nnoremap <leader>bu :<C-U>PudbUpdate<CR>
+<
+
+==============================================================================
+INSTALLATION                                    *vim-pudb-installation*
+
+Similar to any other vim plugin, use your preferred method. If you're new,
+check out:
+
+    packages:     |packages|
+    vim-pathogen: https://github.com/tpope/vim-pathogen#readme
+    vim-plug:     https://github.com/junegunn/vim-plug
+
+
+==============================================================================
+REQUIREMENTS                                    *vim-pudb-requirements*
+
+This plugin needs vim to be compiled with `+python` or `+python3` as well as
+`+signs` and is intended for vim 8.2 or later.
+
+You will also need to have `pudb` installed: https://pypi.org/project/pudb/
+
+
+==============================================================================
+COMMANDS                                        *vim-pudb-commands*
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbToggle*
+:PudbToggle
+    Add / remove a breakpoint at the current line.
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbEdit*
+:PudbEdit
+    Edit the condition of a breakpoint on the current line. Creates a
+    breakpoint if one doesn't already exist.
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbMove*
+:PudbMove
+    Move the location of a breakpoint on the current line.
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbClearAll*
+:PudbClearAll
+    Remove all breakpoints from every file.
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbList*
+:PudbList
+    Show a list of the full file paths, line numbers, and conditions of all
+    breakpoints.
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbLocList*
+:PudbLocList
+    Load all breakpoints into the location list. Does not jump to the first
+    entry.
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbQfList*
+:PudbQfList
+    Load all breakpoints into the quickfix list. Does not jump to the first
+    entry.
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbPopulateList*
+:PudbPopulateList <arg>
+    Supply a list of all breakpoints, in quickfix format, to the Ex command
+    given by <arg>. This is a generic form of PudbLocList and PudbQfList,
+    allowing you to customise the operation for any precise need you may have.
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbUpdate*
+:PudbUpdate
+    Sometimes the breakpoint signs can get out of date. The above commands
+    will all trigger an update, but this command lets you trigger an update
+    without doing anything else.
+
+    NOTE: There should no longer be any need to call this command. Breakpoint
+    signs are updated whenever you save the buffer.
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-:PudbEditFile*
+:PudbEditFile
+    Open the breakpoint file for editing in the current window. Breakpoint
+    signs will not be maintained when saving direct changes to the file.
+
+
+==============================================================================
+CONFIGURATION                                   *vim-pudb-configuration*
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-sign*
+The text of the sign can be defined with `g:pudb_sign`:
+
+    `let g:pudb_sign = 'B>'`
+
+Default: `'B>'`
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-sign-group*
+This plugin uses sign groups. You can change the name of the sign group using
+`g:pudb_sign_group`:
+
+    `let g:pudb_sign_group = 'pudb_sign_group'`
+
+Default: `'pudb_sign_group'`
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-highlight*
+The highlight group of the sign in the sign column can be defined with
+`g:pudb_highlight`:
+
+    `let g:pudb_highlight = 'error'`
+
+Default: `'error'`
+
+------------------------------------------------------------------------------
+                                                *vim-pudb-priority*
+The priority of the breakpoint signs can be defined with `g:pudb_priority`:
+
+    `let g:pudb_priority = 100`
+
+Default: `100`
+
+
+==============================================================================
+KNOWN PROBLEMS                                  *vim-pudb-known-problems*
+
+- There may be room for speed optimisations.
+- There is currently no way to specify which breakpoint file to use.