mathmaker_dev/sheet/Structure.py

# -*- coding: utf-8 -*-

# Mathmaker creates automatically maths exercises sheets
# with their answers
# Copyright 2006-2009 Nicolas Hainaux <nico_h@users.sourceforge.net>

# This file is part of Mathmaker.

# Mathmaker 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
# any later version.

# Mathmaker 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 Mathmaker; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

import error
# -----------------------------------------------------------------------------
# ------------------------------------------- CLASS: sheet.Structure ----------
# -----------------------------------------------------------------------------
##
# @class Structure
# @brief Abstract mother class of all sheets !
# The constructor only has to be reimplemented, it is useless to reimplement
# other methods
class Structure(object):




    # -------------------------------------------------- CONSTRUCTOR ----------
    ##
    #   @brief /!\ Must be redefined. Constructor.
    #   @warning Exception NotInstanciableObject.
    #   @param embedded_machine The machine to be used
    #   @param **options Any options
    def __init__(self, embedded_machine, **options):
        raise error.NotInstanciableObject(self)





    # ----------------------------- OUTPUT WRITING : the whole sheet ----------
    ##
    #   @brief Writes the whole sheet's content to the output.
    #   The whole sheet's content is :
    #        - document's header
    #        - sheet's title & possibly subtitle
    #        - texts of the exercises
    #        - page break
    #        - answers' sheet title
    #        - answers of the exercises
    #        - the close document instruction
    def write_output(self):
        self.machine.write_header()
        self.machine.write_document_begins()
        self.write_sheet_header()
        self.write_sheet_title()
        self.write_sheet_text()
        self.write_texts()
        self.machine.write_jump_to_next_page()
        self.write_answers_title()
        self.write_answers()
        self.machine.write_end_document()





    # ------------------------------- OUTPUT WRITING : sheet's header ---------
    ##
    #   @brief Writes to the output the header of the sheet to be generated
    #   This header is written in a large size. A new line follow it.
    #   It's useful to write headers for test sheets, for example.
    def write_sheet_header(self):
        if self.header != "":
            self.machine.write_set_size_to('large')
            self.machine.write(self.header)
            self.machine.write_new_line()




    # -------------------------------- OUTPUT WRITING : sheet's title ---------
    ##
    #   @brief Writes to the output the title of the sheet to be generated
    #   This title is written in a LARGE size & bolded. Two new lines follow it
    def write_sheet_title(self):
        self.machine.write_set_size_to('LARGE')
        self.machine.write_bold(self.title)
        if self.subtitle != "":
            self.machine.write_new_line()
            self.machine.write_bold(self.subtitle)
        self.machine.write_new_line_twice()





    # ------------------------------- OUTPUT WRITING : answers' title ---------
    ##
    #   @brief Writes to the output title of the answers' sheet to be generated
    #   This title is written in a LARGE size & bolded. Two new lines follow it
    def write_answers_title(self):
        self.machine.write_set_size_to('LARGE')
        self.machine.write_bold(self.answers_title)
        self.machine.write_new_line_twice()





    # ---------------------------------------- OUTPUT WRITING : texts ---------
    ##
    #   @brief Writes to the output all exercises' texts
    def write_texts(self):
        self.machine.write_counter_reset()
        self.machine.write_set_size_to('large')
        for e in self.exercises_list:
            self.machine.write_exercise_number()
            e.write_text()
            self.machine.write_new_line()





    # ----------------------------------- OUTPUT WRITING : sheet text ---------
    ##
    #   @brief Writes to the output the sheet's text
    def write_sheet_text(self):
        if self.text != "":
            self.machine.write(self.text)
            self.machine.write_new_line_twice()






    # -------------------------------------- OUTPUT WRITING : answers ---------
    ##
    #   @brief Writes to the output all exercises' answers
    def write_answers(self):
        self.machine.write_counter_reset()
        self.machine.write_set_size_to('large')
        for e in self.exercises_list:
            self.machine.write_exercise_number()
            e.write_answer()
            self.machine.write_new_line()

---