Igor Spaces

#pragma TextEncoding = "UTF-8"
#pragma rtGlobals=3             // Use modern global access method and strict wave access
#pragma DefaultTab={3,20,4}     // Set default tab width in Igor Pro 9 and later
#pragma IgorVersion = 9.01
// ------------------------------------------------------- //
// Developed by Evangelos Golias (eg)
// 
//  Permission is hereby granted, free of charge, to any person
//  obtaining a copy of this software and associated documentation
//  files (the "Software"), to deal in the Software without
//  restriction, including without limitation the rights to use,
//  copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following
//  conditions:
// 
//  The above copyright notice and this permission notice shall be
//  included in all copies or substantial portions of the Software.
// 
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
//  OTHER DEALINGS IN THE SOFTWARE.
// ------------------------------------------------------- //
// ------------------------------------------------------- //
// Igor Spaces organises windows (Graphs, Tables, Layouts, Notebooks or Panels) in separate
// Spaces. When a Space is selected in the panel, only windows linked to it are shown. 
//
// Igor Spaces organises windows (Graphs, Tables, Layouts, Notebooks or Panels) in separate Spaces.
// When a Space is selected in the panel, only windows linked to it are shown. 
// How it works: 
// 1. Launch Igor Spaces from "Windows/Packages" submenu. 
// 2. Press the "New" button to create a new Space, name should be unique, otherwise you will be
// prompted to change your input. When a new "Space" is created it becomes your active working Space.
// New Spaces are created below the active row selection, and at the moment you cannot change their order.
// 3.Press "Delete" to delete the selected space. Windows associated with the space are released and not
// linked to any space ("" tag)
// 4. Press "All" to show/hide all windows whether linked to a Space or not.
// 5. When the Igor Spaces Panel is open any window you create is associated with the active Space.
// 6. Double click on a row to rename the Space
// 7. Press Shift + Click on a row of the ListBox to move the top window to the selected space
// 8. Press Alt + Click anywhere in the ListBox of the panel (rows or empty space below) to pin the top
// window to all spaces (visible everywhere)
// 9. To unpin press Shift + Alt + Click anywhere in the ListBox to unpin the window (becomes free floating).
// You can also make a normal window free-floating using the same procedure. Alternatively, if you want to
// unpin and link it to a space goto 7.
// ------------------------------------------------------- //

Menu "Windows"
    Submenu "Packages"
        "Spaces", /Q, MXP_MainMenuLaunchSpaces()
    End
End

Function MXP_MainMenuLaunchSpaces()
    if(!DataFolderExists("root:Packages"))
        NewDataFolder root:Packages
    endif
    if(!DataFolderExists("root:Packages:Spaces"))
        NewDataFolder root:Packages:Spaces
    endif
    DFREF dfr = root:Packages:Spaces
    WAVE/Z/T/SDFR=dfr mxpSpacesTW
    NVAR/Z/SDFR=dfr gSelectedSpace
    NVAR/Z/SDFR=dfr gShowAllWindowsSwitch
    if(!WaveExists(mxpSpacesTW)) // If there is no text wave
        Make/T/N=1 dfr:mxpSpacesTW = "Desktop"
        variable/G dfr:gSelectedSpace = 0
        variable/G dfr:gShowAllWindowsSwitch = 0
    endif
    if(!(NVAR_Exists(gSelectedSpace) || NVAR_Exists(gShowAllWindowsSwitch)))
        variable/G dfr:gSelectedSpace = 0
        variable/G dfr:gShowAllWindowsSwitch = 0
    endif
    if(WinType("MXP_SpacesPanel")) // Will return 7 for a panel, 0 if it's not there
        DoWindow/F MXP_SpacesPanel
    else
        MXP_MakeSpacesPanel()
    endif
    return 0
End

Function MXP_MakeSpacesPanel()
    // Scale with IgorOptions here
    DFREF dfr = root:Packages:Spaces
   
    string igorInfoStr = StringByKey( "SCREEN1", IgorInfo(0)) // INFO: Change here if needed
    igorInfoStr = RemoveListItem(0, igorInfoStr, ",")      
    variable screenLeft, screenTop, screenRight, screenBottom, panelLeft, panelTop, panelRight, panelBottom
    sscanf igorInfoStr, "RECT=%d,%d,%d,%d", screenLeft, screenTop, screenRight, screenBottom
    variable screenWidth, screenLength, listlength, listwidth
    screenWidth = abs(screenRight - screenLeft)
    screenLength = abs(screenBottom - screenTop)
   
    // Tune 0.XXX coefficients
    if(screenWidth < 2000)
        panelLeft = screenWidth * 0.85
        panelRight = screenWidth
        panelTop = screenLength * 0.2
        panelBottom = screenLength * 0.8
        listlength = abs(panelBottom - panelTop) * 0.925
        listwidth = abs(panelRight - panelLeft)
    else
        panelLeft = screenWidth * 0.9
        panelRight = screenWidth
        panelTop = screenLength * 0.3
        panelBottom = screenLength * 0.7
        listlength = abs(panelBottom - panelTop) * 0.925
        listwidth = abs(panelRight - panelLeft)
    endif
   
    NVAR/Z/SDFR=dfr gSelectedSpace

    NewPanel /N=MXP_SpacesPanel/W=(panelLeft, panelTop, panelRight, panelBottom) as "Igor Spaces"
    SetDrawLayer UserBack
    Button NewSpace,pos={10,8.00},size={listwidth * 0.25,20.00},help={"Create new space"}
    Button NewSpace,fColor=(3,52428,1),proc=MXP_ListBoxSpacesNewSpace
    Button DeleteSpace,pos={10 + listwidth * 0.075 + listwidth * 0.25,8.00},size={listwidth * 0.25,20.00},title="Delete"
    Button DeleteSpace,help={"Delete existing space"},fColor=(65535,16385,16385),proc=MXP_ListBoxSpacesDeleteSpace
    ListBox listOfspaces,pos={1.00,37.00},size={listwidth,listlength},proc=MXP_ListBoxSpacesHookFunction
    ListBox listOfspaces,fSize=14,frame=2,listWave=dfr:mxpSpacesTW,mode=2,selRow=gSelectedSpace
    Button ShowAll,pos={10 + listwidth * 0.075 * 2 + listwidth * 0.25 * 2,8.00},size={listwidth * 0.25,20.00},title="All"
    Button ShowAll,help={"Show all windows"},fColor=(32768,40777,65535),proc=MXP_ListBoxSpacesShowAll
    return 0
End

// AfterWindowCreatedHook

Function AfterWindowCreatedHook(string windowNameStr, variable winTypevar)
    // Every window created is assigned to the active Space IF the panel is there
    if(WinType("MXP_SpacesPanel"))
        DFREF dfr = root:Packages:Spaces
        WAVE/Z/T/SDFR=dfr mxpSpacesTW
        NVAR/SDFR=dfr gSelectedSpace
        windowNameStr = WinName(0, 87, 1) // Window is created, visible only
        if(DimSize(mxpSpacesTW,0) && cmpstr(windowNameStr,"MXP_SpacesPanel")) // We have to have at least one space
            SetWindow $windowNameStr userdata(MXP_SpacesTag) = mxpSpacesTW[gSelectedSpace]
        endif
    endif
    return 0 // Ignored
End

Function MXP_ListBoxSpacesHookFunction(STRUCT WMListboxAction &LB_Struct)

    DFREF dfr = root:Packages:Spaces
    WAVE/T/SDFR=dfr mxpSpacesTW
    NVAR/SDFR=dfr gSelectedSpace
    string msg, newSpaceNameStr, oldSpaceNameStr, winNameStr
    variable numSpaces = DimSize(mxpSpacesTW, 0)
    variable hookresult = 0
    switch(LB_Struct.eventCode)
        // INFO: When you click outside of entry cells in the ListBox you get maxListEntries as row selection!
        case -1: // Control being killed
            //Do nothing
            break
        case 1: // Mouse down
            gSelectedSpace = LB_Struct.row 
            if(gSelectedSpace > numSpaces - 1)
                gSelectedSpace = numSpaces - 1
            endif
            // Press Option (Mac) or Alt (Windows) and click anywhere in the Listbox to
            // pin the top window (show in all spaces).
            if(LB_Struct.eventMod == 5)
                winNameStr = WinName(1, 87, 0) // Top Window: Graph, Table, Layout, Notebook or Panel
                SetWindow $winNameStr userdata(MXP_SpacesTag) = "MXP__PinnedWindow__MXP" // Assign special tag for pinned window           
            endif
            // Press Shift+Option (Mac) or Shift+Alt (Windows) and click in the Listbox to
            // unpin the top window by setting an empty tag ""
            if(LB_Struct.eventMod == 7)
                winNameStr = WinName(1, 87, 0) // Top Window: Graph, Table, Layout, Notebook or Panel
                SetWindow $winNameStr userdata(MXP_SpacesTag) = "" // Assign special tag for pinned window         
            endif  
            hookresult = 1
            break
        case 2: // Mouse up
            gSelectedSpace = LB_Struct.row
            if(gSelectedSpace > numSpaces - 1)
                gSelectedSpace = numSpaces - 1
            endif  
            hookresult = 1
            break
        case 3: // Double click
            gSelectedSpace = LB_Struct.row
            if (gSelectedSpace > numSpaces - 1)
                hookresult = 1
                break
            endif          
            msg = "Rename Space \"" + mxpSpacesTW[gSelectedSpace] + "\""
            oldSpaceNameStr = mxpSpacesTW[gSelectedSpace]
            newSpaceNameStr = TrimString(MXP_GenericSingleStrPrompt("New name", msg))
            if(!UniqueSpaceNameQ(mxpSpacesTW, newSpaceNameStr) || !strlen(TrimString(newSpaceNameStr))) // if the name is not unique or empty string
                do
                    newSpaceNameStr = TrimString(MXP_GenericSingleStrPrompt("Space name already exists or you entered empty string.", "Enter a *unique* name for the new Space"))
                while(!UniqueSpaceNameQ(mxpSpacesTW, newSpaceNameStr) || !strlen(TrimString(newSpaceNameStr)))
            endif
            mxpSpacesTW[gSelectedSpace] = newSpaceNameStr
            MXP_RenameSpaceTagOnWindows(oldSpaceNameStr, newSpaceNameStr)
            hookresult = 1
            break
        case 4: // Cell selection (mouse or arrow keys)
            gSelectedSpace = LB_Struct.row
            if(gSelectedSpace > numSpaces - 1)
                gSelectedSpace = numSpaces - 1
            endif  
            MXP_ShowWindowsOfSpaceTag(mxpSpacesTW[gSelectedSpace], 1)          
            DoWindow/F $LB_Struct.win // Bring panel to the FG
            hookresult = 1
            break
        case 5: // Cell selection plus Shift key (Assign window to Space)
            // WinName(0, 87) is the "Igor Spaces" panel
            gSelectedSpace = LB_Struct.row
            if (gSelectedSpace > numSpaces - 1)
                hookresult = 1
                break
            endif
            winNameStr = WinName(1, 87, 0) // Top Window: Graph, Table, Layout, Notebook or Panel
            gSelectedSpace = LB_Struct.row
            SetWindow $winNameStr userdata(MXP_SpacesTag) = mxpSpacesTW[gSelectedSpace] // Assign tag to window
            hookresult = 1
            break
    endswitch
    return hookresult
End

Function MXP_ListBoxSpacesNewSpace(STRUCT WMButtonAction &B_Struct): ButtonControl

    DFREF dfr = root:Packages:Spaces
    WAVE/T/SDFR=dfr mxpSpacesTW
    variable index
    variable numEntries = DimSize(mxpSpacesTW, 0)
    NVAR/SDFR=dfr gSelectedSpace
    switch(B_Struct.eventCode)  // numeric switch
        case 2: // "mouse up after mouse down"
            string newSpaceNameStr = TrimString(MXP_GenericSingleStrPrompt("Create a new Space", "Enter the name of the new Space"))
            if(!UniqueSpaceNameQ(mxpSpacesTW, newSpaceNameStr) || !strlen(TrimString(newSpaceNameStr))) // if the name is not unique or empty string
                do
                    newSpaceNameStr = TrimString(MXP_GenericSingleStrPrompt("Space name already exists or you entered empty string.", "Enter a *unique* name for the new Space"))
                while(!UniqueSpaceNameQ(mxpSpacesTW, newSpaceNameStr) || !strlen(TrimString(newSpaceNameStr)))
            endif
           
           
            if (!numEntries) // If you have deleted all spaces
                index = 0
            else
                index = gSelectedSpace + 1
            endif
            InsertPoints index,1, mxpSpacesTW
            mxpSpacesTW[index] = newSpaceNameStr
            // Set the space you created as active
            ListBox listOfspaces, selRow = index
            gSelectedSpace = index
            MXP_ShowWindowsOfSpaceTag(newSpaceNameStr, 1) // Show windows of the new Space - No windows to show!
            break
    endswitch
End

Function MXP_ListBoxSpacesDeleteSpace(STRUCT WMButtonAction &B_Struct): ButtonControl
   
    DFREF dfr = root:Packages:Spaces
    WAVE/T/SDFR=dfr mxpSpacesTW
    variable numSpaces = DimSize(mxpSpacesTW, 0)
    NVAR/SDFR=dfr gSelectedSpace
    string msg
    switch(B_Struct.eventCode)  // numeric switch
        case 2: // "mouse up after mouse down"
            if(numSpaces)
                if(gSelectedSpace > numSpaces - 1)
                    gSelectedSpace = numSpaces - 1
                endif  
                msg = "Do you want to delete \"" + mxpSpacesTW[gSelectedSpace] + "\""
                DoAlert/T="You are about to delete a Space", 1, msg
                if(V_flag == 1)
                    MXP_ClearWindowsFromSpaceTag(mxpSpacesTW[gSelectedSpace]) // has to come first!
                    DeletePoints gSelectedSpace, 1, mxpSpacesTW
                    gSelectedSpace = gSelectedSpace == 0 ? 0: (gSelectedSpace - 1)
                    ListBox listOfspaces, selRow = gSelectedSpace
                endif
            endif
            break
    endswitch
End

Function MXP_ShowWindowsOfSpaceTag(string spaceTagStr, variable showSwitch)
    // showSwitch = 0 (hide window)
    // showSwitch = 1 (show window)
    string winNameStr, getSpacetagStr
    string allWindowsStr = SortList(RemoveFromList("MXP_SpacesPanel",WinList("*",";","WIN:87")), ";", 16)
    variable i, imax = ItemsInList(allWindowsStr)
   
    for(i = 0; i < imax; i++)
        winNameStr = StringFromList(i, allWindowsStr)
        getSpacetagStr = GetUserData(winNameStr, "", "MXP_SpacesTag")
        if(!cmpstr(getSpacetagStr, spacetagStr, 0)) // comparison is case-insensitive.     
            SetWindow $winNameStr hide = 1 - showSwitch // Match
        elseif(!cmpstr(getSpacetagStr, "MXP__PinnedWindow__MXP", 0)) // Pinned window
            SetWindow $winNameStr hide = 0 // Always show
        else
            SetWindow $winNameStr hide = showSwitch
        endif
    endfor
    return 0
End

Function MXP_RenameSpaceTagOnWindows(string oldspaceTagStr, string newspaceTagStr)


    string winNameStr = "", getSpacetagStr
    variable i = 0
    do
        i++
        winNameStr = WinName(i, 87, 0) // i = 0 is the MXP_SpacesPanel, so we skip checking it
        getSpacetagStr = GetUserData(winNameStr, "", "MXP_SpacesTag")
        if(!cmpstr(getSpacetagStr, oldspaceTagStr, 0)) // comparison is case-insensitive.      
            SetWindow $winNameStr userdata(MXP_SpacesTag) = newspaceTagStr
        endif
    while(strlen(winNameStr))
    return 0
End

Function MXP_ClearWindowsFromSpaceTag(string spaceTagStr)

    string winNameStr = "", getSpacetagStr
    variable i = 0
    do
        i++
        winNameStr = WinName(i, 87, 0) // i = 0 is the MXP_SpacesPanel, so we skip checking it
        // Catch "" from setting SetWindow $"" hide = 1/0
        if(!strlen(winNameStr))
            break
        endif
        getSpacetagStr = GetUserData(winNameStr, "", "MXP_SpacesTag")
        if(!cmpstr(getSpacetagStr, spacetagStr, 0)) // comparison is case-insensitive.     
            SetWindow $winNameStr userdata(MXP_SpacesTag) = ""
        endif
    while(strlen(winNameStr))
    return 0
End

Function MXP_ListBoxSpacesShowAll(STRUCT WMButtonAction &B_Struct): ButtonControl
    DFREF dfr = root:Packages:Spaces
    NVAR/SDFR=dfr gShowAllWindowsSwitch
    variable showSwitch
    switch(B_Struct.eventCode)  // numeric switch
        case 2: // "mouse up after mouse down"
            showSwitch = 1 - gShowAllWindowsSwitch
            if(showSwitch)
                gShowAllWindowsSwitch = 1
                MXP_ShowAllWindows(0)
            else
                gShowAllWindowsSwitch = 0
                MXP_ShowAllWindows(1)
            endif
            break
    endswitch
End

Function MXP_ShowAllWindows(variable showSwitch)
    // showSwitch = 0 (hide window)
    // showSwitch = 1 (show window)
    string winNameStr
    variable i = 0
    do
        i++
        winNameStr = WinName(i, 87, 0)
        // Catch "" from setting SetWindow $"" hide = 1/0
        if(!strlen(winNameStr))
            break
        endif
        if(!cmpstr(winNameStr, "MXP_SpacesPanel", 0))
            continue
        endif
        SetWindow $winNameStr hide = 1 - showSwitch
    while(strlen(winNameStr))
    return 0
End

static Function UniqueSpaceNameQ(WAVE/T textW, string spaceNameStr)
    /// Return true of spaceNameStr in not an element of textW (case-insensitive), i.e it is Unique
    variable numEntries = DimSize(textW, 0), i
   
    for(i = 0; i < numEntries; i++)
        if(!cmpstr(textW[i], spaceNameStr))
            return 0
        endif
    endfor
    return 1
End

Function/S MXP_GenericSingleStrPrompt(string strPrompt, string msgDialog)
    string returnStrVar
    Prompt returnStrVar, strPrompt
    DoPrompt msgDialog, returnStrVar
    if(V_flag)
        Abort
    endif
    return returnStrVar
End