CodingChecker Code

""" @file
   Manage rule file class.
   
   Copyright 2012 Lu, Ken (bluewish.ken.lu@gmail.com)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
"""
import os
import logging
import ConfigParser

class CSCRuleFile:
    """
    The rule file is formatted as:
    
    [rule_1]
    description = "This is the description for rule_1" 
    enable =  True
    priority = 1
    """
    
    def __init__(self, filename):
        self._logger = logging.getLogger("rule")
        
        self._filename = filename
        
        if not os.path.exists(self._filename):
            raise Exception("Fail to find the rule file %s" % self._filename)        

        self._config = ConfigParser.ConfigParser()
        self._config.read(self._filename)
        
    def filename(self):
        return self._filename
            
    def check_rule(self, name, description="No description", enable=True):
        if not self._config.has_section(name):
            self._config.add_section(name)
            self._config.set(name, "description", description)
            self._config.set(name, "enable", enable)
            self._config.write(open(self._filename, "w"))
            return enable
        return self._config.getboolean(name, "enable")
    
    def get_rules(self):
        rules = self._config.sections()
        ret = []
        for name in rules:
            ret.append((name, self.check_rule(name)))
        return ret