sw/source/core/inc/dbg_lay.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SW_SOURCE_CORE_INC_DBG_LAY_HXX
  21 #define INCLUDED_SW_SOURCE_CORE_INC_DBG_LAY_HXX
  22
  23 #include <o3tl/typed_flags_set.hxx>
  24 #include <memory>
  25
  26 enum class PROT {
  27     FileInit   = 0x00000000,
  28     Init       = 0x00000001,
  29     MakeAll    = 0x00000002,
  30     MoveFwd    = 0x00000004,
  31     MoveBack   = 0x00000008,
  32     Grow       = 0x00000010,
  33     Shrink     = 0x00000020,
  34     GrowTest   = 0x00000040,
  35     ShrinkTest = 0x00000080,
  36     Size       = 0x00000100,
  37     PrintArea  = 0x00000200,
  38     AdjustN    = 0x00000800,
  39     Section    = 0x00001000,
  40     Cut        = 0x00002000,
  41     Paste      = 0x00004000,
  42     Leaf       = 0x00008000,
  43     TestFormat = 0x00010000,
  44     FrmChanges = 0x00020000,
  45 };
  46 namespace o3tl {
  47     template<> struct typed_flags<PROT> : is_typed_flags<PROT, 0x0003fbff> {};
  48 }
  49
  50 enum class DbgAction {
  51     NONE,
  52     Start, End,
  53     CreateMaster, CreateFollow,
  54     DelMaster, DelFollow,
  55     Merge,
  56     NextSect, PrevSect
  57 };
  58
  59 #ifdef DBG_UTIL
  60
  61 class SwImplProtocol;
  62 class SwFrame;
  63 class SwImplEnterLeave;
  64
  65 class SwProtocol
  66 {
  67     static PROT s_nRecord;
  68     static SwImplProtocol* s_pImpl;
  69     static bool Start() { return bool( PROT::Init & s_nRecord ); }
  70
  71 public:
  72     static PROT Record() { return s_nRecord; }
  73     static void SetRecord( PROT nNew ) { s_nRecord = nNew; }
  74     static bool Record( PROT nFunc ) { return bool(( nFunc | PROT::Init ) & s_nRecord); }
  75     static void Record( const SwFrame* pFrame, PROT nFunction, DbgAction nAction, void* pParam );
  76     static void Init();
  77     static void Stop();
  78 };
  79
  80 class SwEnterLeave
  81 {
  82     std::unique_ptr<SwImplEnterLeave> pImpl;
  83 public:
  84     SwEnterLeave( const SwFrame* pFrame, PROT nFunc, DbgAction nAct, void* pPar );
  85     ~SwEnterLeave();
  86 };
  87
  88 #define PROTOCOL( pFrame, nFunc, nAct, pPar ) {   if( SwProtocol::Record( nFunc ) )\
  89                                                     SwProtocol::Record( pFrame, nFunc, nAct, pPar ); }
  90 #define PROTOCOL_INIT SwProtocol::Init();
  91 #define PROTOCOL_STOP SwProtocol::Stop();
  92 #define PROTOCOL_ENTER( pFrame, nFunc, nAct, pPar ) SwEnterLeave aEnter( pFrame, nFunc, nAct, pPar );
  93
  94 #else
  95
  96 #define PROTOCOL( pFrame, nFunc, nAct, pPar )
  97 #define PROTOCOL_INIT
  98 #define PROTOCOL_STOP
  99 #define PROTOCOL_ENTER( pFrame, nFunc, nAct, pPar )
 100
 101 #endif
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */