cbEVT_WORKSPACE_CLOSE_BEGIN new event

[earlgrey]

I need this event for a plugin.

I define the event in "src/include/sdk_events.h" and "src/sdk/sdk_events.cpp"

1) I fire it in the ProjectManager::CloseWorkspace() method. ( see code below ) - Is that correct ?

2) Are you ok for a patch ?

Code

bool ProjectManager::CloseWorkspace()
{
    bool result = false;
    m_IsClosingWorkspace = true;
    if (m_pWorkspace)
    {
        if (!m_ui->QueryCloseWorkspace())
        {
            m_IsClosingWorkspace = false;
            return false;
        }
        //  ----------------------------------------------------------------->>
        // Fire-up cbEVT_WORKSPACE_CLOSE_BEGIN event
        CodeBlocksEvent event(cbEVT_WORKSPACE_CLOSE_BEGIN);
        Manager::Get()->GetPluginManager()->NotifyPlugins(event);
        //  -----------------------------------------------------------------<<
        // m_ui->QueryCloseWorkspace asked for saving workspace AND projects, no need to do again
        if (!CloseAllProjects(true))
        {
            m_IsClosingWorkspace = false;
            return false;
        }
        delete m_pWorkspace;
        m_pWorkspace = nullptr;

        m_ui->CloseWorkspace();
        result = true;
    }
    else
        result = CloseAllProjects(false);
    m_IsClosingWorkspace = false;
    WorkspaceChanged();
    return result;
}

[oBFusCATed]

First you'll have to describe your use case.
Then we might consider if we want to add it or not. 

[earlgrey]

I work on OpenFilesListPlus plugin, an enhanced version of OpenFilesList plugin.

- Each project stores which sub-panel each of its files belongs to
- The workspace stores the sub-panels layout

For saving the sub-panels layout, I have to detect the workspace closing time.
Unfortunately I did not succeed in this using the existing cbEVT_WORKSPACE_LOADING_COMPLETE and cbEVT_WORKSPACE_CHANGED events.
Adding the cbEVT_WORKSPACE_CLOSE_BEGIN appears to be the best way for achieving my goal.

And incidentally it is only a few lines of code, so please add

Regards ~

[scarphin]

What happens if multiple projects are loaded without a workspace? I mean one by one. Will it still work?

[earlgrey]

What happens if multiple projects are loaded without a workspace? I mean one by one. Will it still work?

"Bulk" sub-panel is always present, with or without workspace loaded. So in your use case, all opened files will appear in the bulk sub-panel.

( Your is case is also the same as if a workspace not defining any sub-panel were loaded ).

[oBFusCATed]

Ok, post a patch, but you must provide the workspace_close_end/finished kind of event, for symmetry.

Do you really need to get an event before the workspace has been closed?

[earlgrey]

Ok thanx, that's great

I will post the patch soon.

[earlgrey]

Here is the patch for svn10499 :
Files modified : sdk_events.h - sdk_events.cpp - projectmanager.cpp

Code

cd svn10499/trunk
patch -R -p2 < svn10499.cbEVT_WORKSPACE_CLOSE.patch

( Hey, the new forum server rocks ! )

[oBFusCATed]

OK, I'll push it some time next week.

p.s. Don't use -R when generating patches.

[earlgrey]

OK, I'll push it some time next week.

Thanks - Great, when done I shall announce some usable version for testing & feedback

p.s. Don't use -R when generating patches.

Noticed -

[earlgrey]

OK, I'll push it some time next week.
p.s. Don't use -R when generating patches.

You did replace some "_CLOSE_" words in my patch by "_CLOSING_" ones, but in sdk_events.h :

Code

extern EVTIMPORT const wxEventType cbEVT_WORKSPACE_CLOSING_BEGIN;
#define EVT_WORKSPACE_CLOSING_BEGIN(fn) DECLARE_EVENT_TABLE_ENTRY( cbEVT_WORKSPACE_CLOSE_BEGIN, -1, -1, (wxObjectEventFunction)(wxEventFunction)(CodeBlocksEventFunction)&fn, (wxObject *) NULL ),
extern EVTIMPORT const wxEventType cbEVT_WORKSPACE_CLOSING_COMPLETE;
#define EVT_WORKSPACE_CLOSING_COMPLETE(fn) DECLARE_EVENT_TABLE_ENTRY( cbEVT_WORKSPACE_CLOSE_COMPLETE, -1, -1, (wxObjectEventFunction)(wxEventFunction)(CodeBlocksEventFunction)&fn, (wxObject *) NULL ),

you forgot "_CLOSE_" words in the DECLARE_EVENT_TABLE_ENTRY(...), so these macros wont be usable.
 

[oBFusCATed]

Should be fixed in trunk.

[earlgrey]

Thx