bastypes.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#pragma once
 
#include "scriptdocument.hxx"
 
#include "sbxitem.hxx"
#include <svtools/scrolladaptor.hxx>
#include <svtools/tabbar.hxx>
#include <basic/sbdef.hxx>
#include <vcl/dockwin.hxx>
#include <vcl/weld.hxx>
 
#include <string_view>
#include <unordered_map>
 
class SbModule;
class SfxItemSet;
class SfxRequest;
class SvxSearchItem;
class Printer;
enum class SearchOptionFlags;
class SfxUndoManager;
 
namespace weld
{
    class Widget;
}
 
namespace basctl
{
 
class Layout;
class ModulWindow;
class DialogWindow;
 
constexpr auto LINE_SEP_CR = 0x0D;
constexpr auto LINE_SEP = 0x0A;
 
// Implementation: baside2b.cxx
sal_Int32 searchEOL( std::u16string_view rStr, sal_Int32 fromIndex );
 
// Meaning of bToBeKilled:
// While being in a reschedule-loop, I may not destroy the window.
// It must first break from the reschedule-loop to self-destroy then.
// Does unfortunately not work that way: Destroying Window with living Child!
 
struct BasicStatus
{
    bool bIsRunning : 1;
    bool bError : 1;
    bool bIsInReschedule : 1;
    BasicDebugFlags nBasicFlags;
 
    BasicStatus():
        bIsRunning(false),
        bError(false),
        bIsInReschedule(false),
        nBasicFlags(BasicDebugFlags::NONE) { }
};
 
 
// basctl::DockingWindow -- special docking window for the Basic IDE
// Not to be confused with ::DockingWindow from vcl.
 
class DockingWindow : public ResizableDockingWindow
{
public:
    DockingWindow(vcl::Window* pParent, const OUString& rUIXMLDescription, const OUString& rID);
    DockingWindow(Layout* pParent);
    virtual ~DockingWindow() override;
    virtual void dispose() override;
    void ResizeIfDocking (Point const&, Size const&);
    void ResizeIfDocking (Size const&);
    Size GetDockingSize () const { return aDockingRect.GetSize(); }
    void SetLayoutWindow (Layout*);
public:
    void Show (bool = true);
    void Hide ();
 
protected:
    virtual bool Docking( const Point& rPos, tools::Rectangle& rRect ) override;
    virtual void     EndDocking( const tools::Rectangle& rRect, bool bFloatMode ) override;
    virtual void     ToggleFloatingMode() override;
    virtual bool PrepareToggleFloatingMode() override;
    virtual void     StartDocking() override;
 
protected:
    std::unique_ptr<weld::Builder> m_xBuilder;
    std::unique_ptr<weld::Container> m_xContainer;
 
private:
    // the position and the size of the floating window
    tools::Rectangle aFloatingRect;
    // the position and the size of the docking window
    tools::Rectangle aDockingRect;
    // the parent layout window (only when docking)
    VclPtr<Layout> pLayout;
    // > 0: shown, <= 0: hidden, ++ by Show() and -- by Hide()
    int nShowCount;
 
    static WinBits const StyleBits;
 
private:
    void DockThis ();
};
 
 
// basctl::TabBar
// Not to be confused with ::TabBar from svtools.
 
class TabBar : public ::TabBar
{
protected:
    virtual void    MouseButtonDown( const MouseEvent& rMEvt ) override;
    virtual void    Command( const CommandEvent& rCEvt ) override;
 
    virtual TabBarAllowRenamingReturnCode  AllowRenaming() override;
    virtual void    EndRenaming() override;
 
public:
    TabBar (vcl::Window* pParent);
 
    void            Sort();
};
 
enum BasicWindowStatus
{
    BASWIN_RUNNINGBASIC = 0x01,
    BASWIN_TOBEKILLED   = 0x02,
    BASWIN_SUSPENDED    = 0x04,
    BASWIN_INRESCHEDULE = 0x08
};
 
class EntryDescriptor;
 
 
// BaseWindow -- the base of both ModulWindow and DialogWindow.
 
class BaseWindow : public vcl::Window
{
private:
    VclPtr<ScrollAdaptor>  pShellHScrollBar;
    VclPtr<ScrollAdaptor>  pShellVScrollBar;
 
    DECL_LINK( VertScrollHdl, weld::Scrollbar&, void );
    DECL_LINK( HorzScrollHdl, weld::Scrollbar&, void );
    int nStatus;
 
    ScriptDocument      m_aDocument;
    OUString            m_aLibName;
    OUString            m_aName;
 
    friend class ModulWindow;
    friend class DialogWindow;
 
protected:
    virtual void    DoScroll(Scrollable* pCurScrollBar);
 
public:
    BaseWindow( vcl::Window* pParent, ScriptDocument aDocument, OUString aLibName, OUString aName );
    virtual         ~BaseWindow() override;
    virtual void    dispose() override;
 
    void            Init();
    virtual void    DoInit();
    virtual void    Activating () = 0;
    virtual void    Deactivating () = 0;
    void            GrabScrollBars(ScrollAdaptor* pHScroll, ScrollAdaptor* pVScroll);
 
    ScrollAdaptor*  GetHScrollBar() const { return pShellHScrollBar.get(); }
    ScrollAdaptor*  GetVScrollBar() const { return pShellVScrollBar.get(); }
    void            ShowShellScrollBars(bool bVisible = true);
 
    virtual void    ExecuteCommand (SfxRequest&);
    virtual void    ExecuteGlobal (SfxRequest&);
    virtual void    GetState (SfxItemSet&) = 0;
    virtual bool    EventNotify( NotifyEvent& rNEvt ) override;
 
    virtual void    StoreData();
    virtual void    UpdateData();
 
    // return number of pages to be printed
    virtual sal_Int32 countPages( Printer* pPrinter ) = 0;
    // print page
    virtual void printPage( sal_Int32 nPage, Printer* pPrinter ) = 0;
 
    virtual OUString         GetTitle();
    OUString                 CreateQualifiedName();
    virtual EntryDescriptor  CreateEntryDescriptor() = 0;
 
    virtual bool    IsModified();
 
    virtual bool    AllowUndo();
 
    virtual void    SetReadOnly (bool bReadOnly);
    virtual bool    IsReadOnly();
    void            ShowReadOnlyInfoBar();
 
    int GetStatus() const { return nStatus; }
    void SetStatus(int n) { nStatus = n; }
    void AddStatus(int n) { nStatus |= n; }
    void ClearStatus(int n) { nStatus &= ~n; }
 
    virtual SfxUndoManager* GetUndoManager ();
 
    virtual SearchOptionFlags  GetSearchOptions();
    virtual sal_uInt16  StartSearchAndReplace (SvxSearchItem const&, bool bFromStart = false);
 
    virtual void    BasicStarted();
    virtual void    BasicStopped();
 
    bool            IsSuspended() const { return nStatus & BASWIN_SUSPENDED; }
 
    const ScriptDocument&
                    GetDocument() const { return m_aDocument; }
    bool            IsDocument( const ScriptDocument& rDocument ) const { return rDocument == m_aDocument; }
    const OUString& GetLibName() const { return m_aLibName; }
 
    const OUString& GetName() const { return m_aName; }
    void            SetName( const OUString& aName ) { m_aName = aName; }
 
    virtual void OnNewDocument ();
    virtual OUString GetHid () const = 0;
    virtual ItemType GetType () const = 0;
    void InsertLibInfo () const;
    bool Is (ScriptDocument const&, std::u16string_view, std::u16string_view, ItemType, bool bFindSuspended);
    virtual bool HasActiveEditor () const;
};
 
class LibInfo
{
public:
    class Item;
public:
    LibInfo ();
    ~LibInfo ();
public:
    void InsertInfo (ScriptDocument const&, OUString const& rLibName, OUString const& rCurrentName, ItemType eCurrentType);
    void RemoveInfoFor (ScriptDocument const&);
    Item const* GetInfo (ScriptDocument const&, OUString const& rLibName);
 
private:
    class Key
    {
    private:
        ScriptDocument  m_aDocument;
        OUString        m_aLibName;
 
    public:
        Key (ScriptDocument , OUString aLibName);
    public:
        bool operator == (Key const&) const;
        struct Hash
        {
            size_t operator () (Key const&) const;
        };
    public:
        const ScriptDocument& GetDocument() const { return m_aDocument; }
    };
public:
    class Item
    {
    private:
        OUString        m_aCurrentName;
        ItemType        m_eCurrentType;
 
    public:
        Item (OUString aCurrentName, ItemType eCurrentType);
        const OUString& GetCurrentName()        const { return m_aCurrentName; }
        ItemType        GetCurrentType()        const { return m_eCurrentType; }
    };
private:
    typedef std::unordered_map<Key, Item, Key::Hash> Map;
    Map m_aMap;
};
 
void            CutLines( OUString& rStr, sal_Int32 nStartLine, sal_Int32 nLines );
OUString CreateMgrAndLibStr( std::u16string_view rMgrName, std::u16string_view rLibName );
sal_uInt32           CalcLineCount( SvStream& rStream );
 
bool QueryReplaceMacro( std::u16string_view rName, weld::Widget* pParent );
bool QueryDelMacro( std::u16string_view rName, weld::Widget* pParent );
bool QueryDelDialog( std::u16string_view rName, weld::Widget* pParent );
bool QueryDelModule( std::u16string_view rName, weld::Widget* pParent );
bool QueryDelLib( std::u16string_view rName, bool bRef, weld::Widget* pParent );
bool QueryPassword(weld::Widget* pDialogParent, const css::uno::Reference< css::script::XLibraryContainer >& xLibContainer, const OUString& rLibName, OUString& rPassword, bool bRepeat = false, bool bNewTitle = false);
 
class ModuleInfoHelper
{
    ModuleInfoHelper (const ModuleInfoHelper&) = delete;
    ModuleInfoHelper& operator = (const ModuleInfoHelper&) = delete;
public:
    static void getObjectName( const css::uno::Reference< css::container::XNameContainer >& rLib, const OUString& rModName, OUString& rObjName );
    static sal_Int32 getModuleType(  const css::uno::Reference< css::container::XNameContainer >& rLib, const OUString& rModName );
};
 
} // namespace basctl
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */