EditExtensionsRevamp: EditExtensionsRevamp.py

# -*- coding: utf-8 -*-

# EditExtensionsRevamp, Wikidpad plugin
# by alessandro orsi
# v1.0, 14 Sep 2011, license GPL



import wx
import re



# === Wikidpad Keyboad Shortcut ===

# Descriptor for EditorFunctions plugin type
WIKIDPAD_PLUGIN = (("MenuFunctions",1),)

def describeMenuItems(wiki):

    """ Reads the keyboard shortcut from WP configuration file, 
        if it doesn't exist assign a default one """

    keybindings = wiki.getKeyBindings()
    
    kb = keybindings.EdExRevamp
    
    if kb == '':
        
        kb = u'Ctrl-Alt-M'

    return ((EdExtRevamp, u'Edit Extensions Revamp' + u'\t' + kb , 'A revamped Edit Extensions plugin'),)

    
    

# === WX DIALOGUES ===

class EdExtDialogue ( wx.Dialog ):
        
    """ Dialogue for the Insert before/after function """
    
    def __init__( self, parent ):
        wx.Dialog.__init__ ( self, parent, id = wx.ID_ANY, title = u"Edit Extensions Revamp", pos = wx.DefaultPosition, size = wx.Size( 269,183 ), style = wx.CAPTION|wx.STAY_ON_TOP )

        self.SetSizeHintsSz( wx.DefaultSize, wx.DefaultSize )

        main_sizer = wx.BoxSizer( wx.VERTICAL )

        self.label_before = wx.StaticText( self, wx.ID_ANY, u"Before:", wx.DefaultPosition, wx.DefaultSize, 0 )
        self.label_before.Wrap( -1 )
        main_sizer.Add( self.label_before, 0, wx.ALL, 5 )

        self.txt_before = wx.TextCtrl( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 )
        main_sizer.Add( self.txt_before, 0, wx.EXPAND|wx.LEFT|wx.RIGHT, 5 )

        self.label_after = wx.StaticText( self, wx.ID_ANY, u"After", wx.DefaultPosition, wx.DefaultSize, 0 )
        self.label_after.Wrap( -1 )
        main_sizer.Add( self.label_after, 0, wx.ALL, 5 )

        self.txt_after = wx.TextCtrl( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 )
        main_sizer.Add( self.txt_after, 0, wx.EXPAND|wx.LEFT|wx.RIGHT, 5 )

        btns_sizer = wx.StdDialogButtonSizer()
        self.btns_sizerOK = wx.Button( self, wx.ID_OK )
        btns_sizer.AddButton( self.btns_sizerOK )
        self.btns_sizerCancel = wx.Button( self, wx.ID_CANCEL )
        btns_sizer.AddButton( self.btns_sizerCancel )
        btns_sizer.Realize();
        main_sizer.Add( btns_sizer, 1, wx.ALIGN_RIGHT|wx.RIGHT, 5 )

        self.SetSizer( main_sizer )
        self.Layout()

        self.Centre( wx.BOTH )
        
        # For Linux, or the control won't get the focus
        self.txt_before.SetFocus()
        


# === FUNCTIONS ===

def lowercase(wiki, evt, text):

    """ Converts the selected text to lower case """

    text = text.lower()

    wiki.getActiveEditor().ReplaceSelection(text)

    
def uppercase(wiki, evt, text):

    """ Converts the selected text to upper case """

    text = text.upper()

    wiki.getActiveEditor().ReplaceSelection(text)
    
    
def invert_case(wiki, evt, text):

    """ Inverts the case of each character in the selected text """

    text = text.swapcase()

    wiki.getActiveEditor().ReplaceSelection(text)
    

def title_case(wiki, evt, text):

    """ Capitalizes the first character of each word in the selected text """

    text = text.title()

    wiki.getActiveEditor().ReplaceSelection(text)


def sentence_case(wiki, evt, text):

    """ Capitalizes the first character of each line in the selected text """

    # Store lines in a list
    lines = text.split('\n')

    # Loop through each line
    for line in range(len(lines)):

        mod_line= ''
        first_alpha_chr = True

        # Loop through each character in a line
        for pos in range(len(lines[line])):

            # Check if it is an alphabetic character
            if lines[line][pos].isalpha():


                # If it's the first alphabetical character, capitalize
                if first_alpha_chr:

                    mod_line = mod_line + lines[line][pos].upper()
                    first_alpha_chr = False

                # otherwise convert to lower case
                else:

                    mod_line = mod_line + lines[line][pos].lower()


            else:

                # if char is not alphabhetic leave unchanged
                mod_line = mod_line + lines[line][pos]


        lines[line] = mod_line

    # Convert the list in a string
    modified_lines = '\n'.join(lines)

    wiki.getActiveEditor().ReplaceSelection(modified_lines)

    
def trim_spaces(wiki, env,text):

    """ Remove leading and trailing spaces from each line in the selection """

    # Store lines in a list
    lines = text.split('\n')

    for id in range(len(lines)):

        lines[id] = lines[id].strip()

    # Convert the list in a string
    modified_lines = '\n'.join(lines)

    wiki.getActiveEditor().ReplaceSelection(modified_lines)


def compress_spaces(wiki, env, text):

    """ Leave only one space between words in the selection """

    text = re.sub(r'[ ]{2,}', ' ', text)

    wiki.getActiveEditor().ReplaceSelection(text)
    

def insert_before_after(wiki, evt, text):

    """ Shows a dialog where the user can enter one or two strings
    The strings are than added respectively at the beginning and at
    the end of each line in the selection

    """
  
    dlg = EdExtDialogue(wiki)

    status = dlg.ShowModal()
    
    if status == wx.ID_CANCEL:
        return
    
    before = dlg.txt_before.GetValue()
    after = dlg.txt_after.GetValue()

    dlg.Destroy()
    
    # User didn't enter any value but clicked OK
    if before == after == '':
        return
    
    # Store lines in a list
    lines = text.split('\n')

    for id in range(len(lines)):

        # Modify line only if it's not blank
        if lines[id] != '':
            lines[id] = before + lines[id] + after

    # Convert the list in a string
    modified_lines = '\n'.join(lines)

    wiki.getActiveEditor().ReplaceSelection(modified_lines)


    
    
# === POP UP MENU ==

def EdExtRevamp(wiki, evt):

    """ Called by Wikidpad through the shortcut, builds and shows the popup menu """

    class EdExtPopupMenu(wx.Menu):
        def __init__(self, parent, sel):
            wx.Menu.__init__(self)

            self.parent = parent
            self.sel = sel
            
            # Lower case
            lower = wx.MenuItem(self, wx.NewId(), '&Lower')
            self.AppendItem(lower)
            self.Bind(wx.EVT_MENU, self.OnLower, id=lower.GetId())
            
            # Upper case
            upper = wx.MenuItem(self, wx.NewId(), '&Upper')
            self.AppendItem(upper)
            self.Bind(wx.EVT_MENU, self.OnUpper, id=upper.GetId())

            # Invert case
            invert = wx.MenuItem(self, wx.NewId(), '&Invert')
            self.AppendItem(invert)
            self.Bind(wx.EVT_MENU, self.OnInvert, id=invert.GetId())
            
            # Title case
            title = wx.MenuItem(self, wx.NewId(), '&Title')
            self.AppendItem(title)
            self.Bind(wx.EVT_MENU, self.OnTitle, id=title.GetId())

            # Sentence case - works on multiple lines
            sentence = wx.MenuItem(self, wx.NewId(), '&Sentence')
            self.AppendItem(sentence)
            self.Bind(wx.EVT_MENU, self.OnSentence, id=sentence.GetId())
            
            # Trim spaces - works on multiple lines
            trim = wx.MenuItem(self, wx.NewId(), 'T&rim spaces')
            self.AppendItem(trim)
            self.Bind(wx.EVT_MENU, self.OnTrim, id=trim.GetId())                        
            
            # Compress spaces - works on multiple lines
            compress = wx.MenuItem(self, wx.NewId(), '&Compress spaces')
            self.AppendItem(compress)
            self.Bind(wx.EVT_MENU, self.OnCompress, id=compress.GetId()) 
            
            # Insert before/after - works on multiple lines
            insert_ba = wx.MenuItem(self, wx.NewId(), 'I&nsert before/after')
            self.AppendItem(insert_ba)
            self.Bind(wx.EVT_MENU, self.OnInsertBA, id=insert_ba.GetId()) 
            

        # Menu items events           
        
        def OnLower(self, event):
            lowercase(wiki, evt, self.sel)

        def OnUpper(self, event):
            uppercase(wiki, evt, self.sel)
            
        def OnInvert(self, event):
            invert_case(wiki, evt, self.sel)
            
        def OnTitle(self, event):
            title_case(wiki, evt, self.sel)
            
        def OnSentence(self, event):
            sentence_case(wiki, evt, self.sel)
        
        def OnTrim(self, event):
            trim_spaces(wiki, evt, self.sel)

        def OnCompress(self, event):
            compress_spaces(wiki, evt, self.sel)        
            
        def OnInsertBA(self, event):
            insert_before_after(wiki, evt, self.sel)
            
            
    
    # === CODE CALLED FROM WIKIDPAD STARTS HERE ===
            
    # Get selected text in the editor
    Selection = wiki.getActiveEditor().GetSelectedText()

    # Check if the selection is empty
    if Selection == '':
        wx.MessageBox('Please, select some text first', 'Info')
        return
    
    # Store current caret position
    pos = wiki.getActiveEditor().GetCurrentPos()
    

    # Convert caret position to pixel coordinates (relative to window)
    point = wiki.getActiveEditor().PointFromPosition(pos)

    
    # Conver pixel coordinates relative to window to coordinates relative to screen
    # otherwise the position of the popup will change depending on if the tree is 
    # showed or hidden
    scr_coord = wiki.getActiveEditor().ClientToScreen(point)
    
    # Create the popup menu
    wiki.PopupMenu(EdExtPopupMenu(wiki, Selection), scr_coord)
    
    # Put back the caret where it was
    wiki.getActiveEditor().SetCurrentPos(pos)