Files
harbour-core/contrib/xhb/classex.ch
Viktor Szakats 5a2a287752 2017-09-08 16:00 UTC Viktor Szakats (vszakats users.noreply.github.com)
* *
    * partial sync with the 3.4 fork codebase. These are the things
      synces for the most part:
      - copyright headers
      - grammar/typos in comments and some readmes
      - comment/whitespace/decorations
      - variable scoping in C files
      - DO CASE/SWITCH and some other alternate syntax usage
      - minimal amount of human readable text in strings
      - minor code updates
      - HB_TRACE() void * casts for pointers and few other changes to
        avoid C compiler warnings
      - various other, minor code cleanups
      - only Harbour/C code/headers were touched in src, utils, contrib,
        include. No 3rd party code, no make files, and with just a few
        exceptions, no 'tests' code was touched.
      - certain components were not touched were 3.4 diverged too much
        already, like f.e. hbmk2, hbssl, hbcurl, hbexpat
      - the goal was that no actual program logic should be altered by
        these changes. Except some possible minor exceptions, any such
        change is probably a bug in this patch.
      It's a massive patch, if you find anything broken after it, please
      open an Issue with the details. Build test was done on macOS.
      The goal is make it easier to see what actual code/logic was changed
      in 3.4 compared to 3.2 and to make patches easier to apply in both
      ways.
2017-09-08 16:25:13 +00:00

178 lines
7.9 KiB
Plaintext

/*
* Class Extension
*
* Copyright 2002 Francesco Saverio Giudice [info@fsgiudice.com]
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; see the file LICENSE.txt. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA (or visit https://www.gnu.org/licenses/).
*
* As a special exception, the Harbour Project gives permission for
* additional uses of the text contained in its release of Harbour.
*
* The exception is that, if you link the Harbour libraries with other
* files to produce an executable, this does not by itself cause the
* resulting executable to be covered by the GNU General Public License.
* Your use of that executable is in no way restricted on account of
* linking the Harbour library code into it.
*
* This exception does not however invalidate any other reasons why
* the executable file might be covered by the GNU General Public License.
*
* This exception applies only to the code released by the Harbour
* Project under the name Harbour. If you copy code from other
* Harbour Project or Free Software Foundation releases into a copy of
* Harbour, as the General Public License permits, the exception does
* not apply to the code that you add in this way. To avoid misleading
* anyone as to the status of such modified files, you must delete
* this exception notice from them.
*
* If you write modifications of your own for Harbour, it is your choice
* whether to permit this exception to apply to your modifications.
* If you do not wish that, delete this exception notice.
*
*/
/* Class Extension
Property is a better way to write DATA ACCESS in classes
The command is:
PROPERTY varname [AS type] [INIT value] [INDEX pos]
[READ mtread] [WRITE mtwrite]
where
- varname = the visible DATA name. *** INTERNAL DATA is stored with F prefix ***
so when you have to access this data you have to refer with F prefix
example:
....
PROPERTY Title READ GetTitle
....
METHOD GetTitle INLINE ::FTitle
....
internal data is stored with HIDDEN scope so you cannot access it
outside of declaration file
- type = the type of data - see DATA help for explanation
- value = initial value of var
- pos = index is a powerful access method. You can use same method to get/set
data, but trough index you can access to correct data.
example:
....
PROPERTY Top AS NUMERIC INIT 10 INDEX 1 READ GetCoord WRITE SetCoord
PROPERTY Left AS NUMERIC INIT 0 INDEX 2 READ GetCoord WRITE SetCoord
....
METHOD SetCoord( i, x ) // Look at index parameter
DO CASE
CASE i == 1 // Top
::FTop := x
CASE i == 2 // Left
::FLeft := x
...
ENDCASE
::Changed := .T.
RETURN Self
METHOD GetCoord( i )
LOCAL nRet
DO CASE
CASE i == 1 // Top
nRet := ::FTop
CASE i == 2 // Left
nRet := ::FLeft
...
ENDCASE
RETURN nRet
- mtread = the method to read DATA. It can be a method name or directly the
internal data name.
example:
....
PROPERTY Title READ FTitle WRITE SetTitle
....
METHOD SetTitle(x) INLINE ::FTitle := x, ::Changed := .T.
....
- mtwrite = the method to write DATA. It can be a method name or directly the
internal data name.
example above.
*/
#xcommand PROPERTY <x> [TYPE <type>] [AS <astype>] [INDEX <i>] READ <rf> WRITE <wf> [DEFAULT <d>];
[<scope: EXPORTED, EXPORT, VISIBLE, PUBLIC, PROTECTED, HIDDEN, PRIVATE, READONLY, RO, PUBLISHED >] ;
=> ;
DATA T_<x> AS STRING INIT <(type)> PROTECTED ;;
#xtranslate __FNAME(<x>) => F<x> ;;
DATA __FNAME(<x>) [AS <astype>] PROTECTED [INIT <d>] ;;
ACCESS <x> INLINE ::<rf>( [ <i> ] ) ;;
ASSIGN <x>(v) INLINE ::<wf>( [ <i>, ] v)
#xcommand PROPERTY <x> [AS <astype>] [INDEX <i>] READ <rf> WRITE <wf> [DEFAULT <d>];
[<scope: EXPORTED, EXPORT, VISIBLE, PUBLIC, PROTECTED, HIDDEN, PRIVATE, READONLY, RO, PUBLISHED >] ;
=> ;
#xtranslate __FNAME(<x>) => F<x> ;;
DATA __FNAME(<x>) [AS <astype>] PROTECTED [INIT <d>] ;;
ACCESS <x> INLINE ::<rf>( [ <i> ] ) ;;
ASSIGN <x>(v) INLINE ::<wf>( [ <i>, ] v)
#xcommand PROPERTY <x> [TYPE <type>] [AS <astype>] [INDEX <i>] WRITE <wf> [DEFAULT <d>];
[<scope: EXPORTED, EXPORT, VISIBLE, PUBLIC, PROTECTED, HIDDEN, PRIVATE, READONLY, RO, PUBLISHED >] ;
=> ;
DATA T_<x> AS STRING INIT <(type)> PROTECTED ;;
#xtranslate __FNAME(<x>) => F<x> ;;
DATA __FNAME(<x>) [AS <astype>] PROTECTED [INIT <d>] ;;
ASSIGN <x>(v) INLINE ::<wf>( [ <i>, ] v)
#xcommand PROPERTY <x> [AS <astype>] [INDEX <i>] WRITE <wf> [DEFAULT <d>];
[<scope: EXPORTED, EXPORT, VISIBLE, PUBLIC, PROTECTED, HIDDEN, PRIVATE, READONLY, RO, PUBLISHED >] ;
=> ;
#xtranslate __FNAME(<x>) => F<x> ;;
DATA __FNAME(<x>) [AS <astype>] PROTECTED [INIT <d>] ;;
ASSIGN <x>(v) INLINE ::<wf>( [ <i>, ] v)
#xcommand PROPERTY <x> [TYPE <type>] [AS <astype>] [INDEX <i>] READ <rf> [DEFAULT <d>];
[<scope: EXPORTED, EXPORT, VISIBLE, PUBLIC, PROTECTED, HIDDEN, PRIVATE, READONLY, RO, PUBLISHED >] ;
=> ;
DATA T_<x> AS STRING INIT <(type)> PROTECTED ;;
#xtranslate __FNAME(<x>) => F<x> ;;
DATA __FNAME(<x>) [AS <astype>] PROTECTED [INIT <d>] ;;
ACCESS <x> INLINE ::<rf>( [ <i> ] )
#xcommand PROPERTY <x> [AS <astype>] [INDEX <i>] READ <rf> [DEFAULT <d>];
[<scope: EXPORTED, EXPORT, VISIBLE, PUBLIC, PROTECTED, HIDDEN, PRIVATE, READONLY, RO, PUBLISHED >] ;
=> ;
#xtranslate __FNAME(<x>) => F<x> ;;
DATA __FNAME(<x>) [AS <astype>] PROTECTED [INIT <d>] ;;
ACCESS <x> INLINE ::<rf>( [ <i> ] )
#xcommand PROPERTY <x> [TYPE <type>] [AS <astype>] [DEFAULT <d>];
[<scope: EXPORTED, EXPORT, VISIBLE, PUBLIC, PROTECTED, HIDDEN, PRIVATE, READONLY, RO, PUBLISHED >] ;
=> ;
DATA T_<x> AS STRING INIT <(type)> PROTECTED ;;
#xtranslate __FNAME(<x>) => F<x> ;;
DATA __FNAME(<x>) [AS <astype>] EXPORTED [INIT <d>]
#xcommand PROPERTY <x> [AS <astype>] [DEFAULT <d>];
[<scope: EXPORTED, EXPORT, VISIBLE, PUBLIC, PROTECTED, HIDDEN, PRIVATE, READONLY, RO, PUBLISHED >] ;
=> ;
#xtranslate __FNAME(<x>) => F<x> ;;
DATA __FNAME(<x>) [AS <astype>] EXPORTED [INIT <d>]
#xtranslate __FNAME(<x>) => F<x>