~ubuntu-branches/debian/squeeze/sword/squeeze

« back to all changes in this revision

Viewing changes to include/swcom.h

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Marsden, Jonathan Marsden, Dmitrijs Ledkovs, Closed Bugs
  • Date: 2009-05-30 11:55:55 UTC
  • mfrom: (1.3.1 upstream) (6.1.1 experimental)
  • Revision ID: james.westby@ubuntu.com-20090530115555-r427zsn3amivdpfu
Tags: 1.6.0+dfsg-1
[ Jonathan Marsden ]
* New upstream release. (Closes: #507960) (LP: #320558)
* debian/patches/02_libver.diff:
  - Bump SONAME to 8 -- SWORD 1.6 is not backward compatible with 1.5.11.
* debian/patches/series:
  - Remove 10_diatheke.diff -- included in upstream source.
* debian/patches/:
  - Remove several old unused .diff files.
  - Add 11_regex_only_when_needed.diff to conditionally include regex lib.
  - Add 12_fix_compiler_warnings.diff to remove all compiler warnings.
  - Add 13_fix_osis2mod_compression_default.diff from upstream svn.
  - Add 14_closing_section_not_chapter.diff from upstream svn.
* debian/libsword7.*: 
  - Rename to libsword8.*
  - Change libsword7 to libsword8 within files.
* debian/rules: 
  - SONAME bump to 8.
  - Set library version check to >= 1.6
* debian/control:
  - Change libsword7 to libsword8.
  - Add libsword7 to Conflicts.
  - Fix case of sword to SWORD in package descriptions.
  - Bump Standards-Version to 3.8.1 (no changes needed).
  - Fix section for libsword-dbg to avoid lintian warning.
* debian/rules:
  - Add DFSG get-orig-source target.
* debian/copyright:
  - Fix various mistakes in initial attempt to document copyrights.

[ Dmitrijs Ledkovs ]
* debian/rules: Added utils.mk to use missing-files target and call it on
  each build.
* debian/libsword-dev.install: Added libsword.la, previously missing.
* debian/libsword7.install: Added missing libicu translit files.
* debian/control:
  - Updated all uses of SWORD version to 1.6
  - Added libsword-dbg package
* debian/watch: Fixed a small mistake which was resulting in extra "."
  in final version name.
* debian/rules: simplified manpage processing.
* debian/libsword8.lintian-overrides: added override for module
  installation directory.
* debian/copyright: Updated with information about everyfile.
  Closes: #513448 LP: #322638
* debian/diatheke.examples: moved examples here from the diatheke.install
* debian/rules:
  - enabled shell script based testsuite
  - added commented out cppunit testsuite
* debian/patches/40_missing_includes.diff: 
  - added several missing stdio.h includes to prevent FTBFS of testsuite.

[ Closed Bugs ]
* FTBFS on intrepid (LP: #305172)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/******************************************************************************
 
2
 *  swcom.h   - code for base class 'SWCom'.  SWCom is the basis for all
 
3
 *               types of commentary modules.
 
4
 *               It is traditionally close to the same as the SWText
 
5
 *               module type, but has defaults set which more
 
6
 *               closely represent how a commentary will be used and how
 
7
 *               the bulk of our commentaries expect to be used.  For example,
 
8
 *               most commentaries consist of entries for a range of text
 
9
 *               (Matt.1.1-6: "Matthew begins with by telling us...").  This
 
10
 *               same entry will be returned when any verse between Matt.1.1-6
 
11
 *               is requested from the engine.  This is done with verse linking.
 
12
 *               Since linking is used heavily in commentaries, the flag
 
13
 *               skipConsecutiveLinks is defaulted to true so when the
 
14
 *               commentary is incremented, it will go to the next ENTRY,
 
15
 *               not the next verse (likely Matt.1.7, from our example above).
 
16
 *
 
17
 * $Id: swcom.h 2362 2009-04-29 07:21:35Z scribe $
 
18
 *
 
19
 * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
 
20
 *      CrossWire Bible Society
 
21
 *      P. O. Box 2528
 
22
 *      Tempe, AZ  85280-2528
 
23
 *
 
24
 * This program is free software; you can redistribute it and/or modify it
 
25
 * under the terms of the GNU General Public License as published by the
 
26
 * Free Software Foundation version 2.
 
27
 *
 
28
 * This program is distributed in the hope that it will be useful, but
 
29
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 
30
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
31
 * General Public License for more details.
 
32
 *
 
33
 */
 
34
 
 
35
#ifndef SWCOM_H
 
36
#define SWCOM_H
 
37
 
 
38
#include <swmodule.h>
 
39
 
 
40
#include <defs.h>
 
41
 
 
42
SWORD_NAMESPACE_START
 
43
 
 
44
class VerseKey;
 
45
class SWKey;
 
46
 
 
47
  /** The basis for all commentary modules
 
48
  */
 
49
class SWDLLEXPORT SWCom : public SWModule {
 
50
 
 
51
        mutable VerseKey *tmpVK1;
 
52
        mutable VerseKey *tmpVK2;
 
53
        mutable bool tmpSecond;
 
54
        char *versification;
 
55
 
 
56
protected:
 
57
        VerseKey &getVerseKey(const SWKey *key = 0) const;
 
58
 
 
59
 
 
60
public:
 
61
 
 
62
        /** Initializes data for instance of SWCom
 
63
        */
 
64
        SWCom(const char *imodname = 0, const char *imoddesc = 0,
 
65
                        SWDisplay *idisp = 0, SWTextEncoding enc = ENC_UNKNOWN,
 
66
                        SWTextDirection dir = DIRECTION_LTR,
 
67
                        SWTextMarkup mark = FMT_UNKNOWN, const char *ilang = 0,
 
68
                        const char *versification = "KJV");
 
69
 
 
70
        virtual ~SWCom();
 
71
        virtual SWKey *CreateKey() const;
 
72
 
 
73
        virtual long Index() const;
 
74
        virtual long Index(long iindex);
 
75
 
 
76
 
 
77
 
 
78
        // OPERATORS -----------------------------------------------------------------
 
79
        
 
80
        SWMODULE_OPERATORS
 
81
 
 
82
};
 
83
 
 
84
SWORD_NAMESPACE_END
 
85
#endif