configurationengine/source/plugins/example/ConeExamplePlugin/examplemlplugin/exampleml_model.py
author m2lahtel
Tue, 10 Aug 2010 14:29:28 +0300
changeset 3 e7e0ae78773e
parent 0 2e8eeb919028
permissions -rw-r--r--
ConE 1.2.11 release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
# All rights reserved.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
# This component and the accompanying materials are made available
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
# under the terms of "Eclipse Public License v1.0"
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
# which accompanies this distribution, and is available
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
# Initial Contributors:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
# Nokia Corporation - initial contribution.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
# Contributors:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
# Description:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
import os
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
import sys
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
import logging
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
from cone.public import utils
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
class Output(object):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
    Class representing an ExampleML output element.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    27
    
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    28
    def __init__(self, file, encoding, text, lineno=None):
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
        self.file = file
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
        self.encoding = encoding
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    31
        self.text = text
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    32
        self.lineno = lineno
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    33
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    34
    def get_refs(self):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    35
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    36
        Return a list of all ConfML refs used in this output object.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    37
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
        return utils.extract_delimited_tokens(self.text)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    40
    def get_output_file(self, output_dir, config):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    41
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    42
        Return the path of the output file specified by this output object.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    43
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    44
        # Expand ConfML references
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    45
        file = utils.expand_refs_by_default_view(self.file, config.get_default_view())
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    46
        return os.path.normpath(os.path.join(output_dir, file))
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    47
    
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    48
    def write_to_file(self, output_dir, context):
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    49
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
        Write the text file specified by this output object to the
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    51
        given output directory.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
        """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
        # Get the actual output path and encoding
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    54
        file_path = self.get_output_file(output_dir, context.configuration)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    55
        encoding = utils.expand_refs_by_default_view(self.encoding, context.configuration.get_default_view())
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    56
        
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    57
        # Generate the binary data to write
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    58
        text = utils.expand_refs_by_default_view(self.text, context.configuration.get_default_view())
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    59
        data = text.encode(encoding)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    60
        
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    61
        
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    62
        # Write the file.
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    63
        f = context.create_file(file_path, mode="wb")
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    64
        try:        f.write(data)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    65
        finally:    f.close()
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    66
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    67
    def __eq__(self, other):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    68
        if type(self) is type(other):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    69
            for varname in ('file', 'encoding', 'text'):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    70
                if getattr(self, varname) != getattr(other, varname):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    71
                    return False
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    72
            return True
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    73
        else:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    74
            return False
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    75
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    76
    def __ne__(self, other):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    77
        return not (self == other)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    78
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    79
    def __repr__(self):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    80
        return "Output(file=%r, encoding=%r, text=%r)" % (self.file, self.encoding, self.text)