page.m 2.72 KB
Newer Older
Houtan Bastani's avatar
Houtan Bastani committed
1
2
function o = page(varargin)
%function o = page(varargin)
Houtan Bastani's avatar
Houtan Bastani committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
% Page Class Constructor
%
% INPUTS
%   0 args => empty page
%   1 arg (page class) => copy object
%
% OUTPUTS
%   none
%
% SPECIAL REQUIREMENTS
%   none

% Copyright (C) 2013 Dynare Team
%
% This file is part of Dynare.
%
% Dynare 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 3 of the License, or
% (at your option) any later version.
%
% Dynare 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 Dynare.  If not, see <http://www.gnu.org/licenses/>.

Houtan Bastani's avatar
Houtan Bastani committed
32
o = struct;
Houtan Bastani's avatar
Houtan Bastani committed
33
o.paper = '';
34
o.title = {};
35
o.titleFormat = {};
Houtan Bastani's avatar
Houtan Bastani committed
36
o.orientation = '';
37
o.footnote = {};
Houtan Bastani's avatar
Houtan Bastani committed
38
o.sections = sections();
Houtan Bastani's avatar
Houtan Bastani committed
39

Houtan Bastani's avatar
Houtan Bastani committed
40
if nargin == 1
41
42
    assert(isa(varargin{1}, 'page'), ['@page.page: with one arg to Page ' ...
                        'constructor, you must pass a page object']);
Houtan Bastani's avatar
Houtan Bastani committed
43
44
45
46
    o = varargin{1};
    return;
elseif nargin > 1
    if round(nargin/2) ~= nargin/2
47
        error(['@page.page: options must be supplied in name/value ' ...
Houtan Bastani's avatar
Houtan Bastani committed
48
49
50
               'pairs.']);
    end

51
    optNames = fieldnames(o);
Houtan Bastani's avatar
Houtan Bastani committed
52
53
54

    % overwrite default values
    for pair = reshape(varargin, 2, [])
55
        ind = strmatch(lower(pair{1}), lower(optNames), 'exact');
56
57
58
        assert(isempty(ind) || length(ind) == 1);
        if ~isempty(ind)
            o.(optNames{ind}) = pair{2};
Houtan Bastani's avatar
Houtan Bastani committed
59
        else
60
            error('@page.page: %s is not a recognized option.', pair{1});
Houtan Bastani's avatar
Houtan Bastani committed
61
62
63
64
        end
    end
end

65
% Check options provided by user
66
if ischar(o.title)
Houtan Bastani's avatar
Houtan Bastani committed
67
    o.title = {o.title};
68
end
69
70
if ischar(o.titleFormat)
    o.titleFormat = {o.titleFormat};
71
72
73
end
assert(iscellstr(o.title), ...
       '@page.page: title must be a cell array of strings');
74
75
76
77
assert(iscellstr(o.titleFormat), ...
       '@page.page: titleFormat must be a cell array of strings');
assert(length(o.title)==length(o.titleFormat), ...
       '@page.page: title and titleFormat must be of the same length');
78
79
80
81
82
83
84
85
86

valid_paper = {'a4', 'letter'};
assert(any(strcmp(o.paper, valid_paper)), ...
       ['@page.page: paper must be one of ' strjoin(valid_paper, ' ')]);

valid_orientation = {'portrait', 'landscape'};
assert(any(strcmp(o.orientation, valid_orientation)), ...
       ['@page.page: orientation must be one of ' strjoin(valid_orientation, ' ')]);

87
if ischar(o.footnote)
Houtan Bastani's avatar
Houtan Bastani committed
88
    o.footnote = {o.footnote};
89
end
90
91
assert(iscellstr(o.footnote), ...
       '@page.page: footnote must be a cell array of string(s)');
92

Houtan Bastani's avatar
Houtan Bastani committed
93
94
% Create page object
o = class(o, 'page');
Houtan Bastani's avatar
Houtan Bastani committed
95
end