BaseTools: Rename String to StringUtils.

[mirror_edk2.git] / BaseTools / Source / Python / Table / TablePcd.py

## @file\r
# This file is used to create/update/query/erase table for pcds\r
#\r
# Copyright (c) 2008, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
##\r
# Import Modules\r
#\r
import Common.EdkLogger as EdkLogger\r
from Table import Table\r
from Common.StringUtils import ConvertToSqlString\r
\r
## TablePcd\r
#\r
# This class defined a table used for pcds\r
# \r
# @param object:       Inherited from object class\r
#\r
#\r
class TablePcd(Table):\r
    def __init__(self, Cursor):\r
        Table.__init__(self, Cursor)\r
        self.Table = 'Pcd'\r
    \r
    ## Create table\r
    #\r
    # Create table Pcd\r
    #\r
    # @param ID:                   ID of a Pcd\r
    # @param CName:                CName of a Pcd\r
    # @param TokenSpaceGuidCName:  TokenSpaceGuidCName of a Pcd\r
    # @param Token:                Token of a Pcd\r
    # @param DatumType:            DatumType of a Pcd\r
    # @param Model:                Model of a Pcd\r
    # @param BelongsToFile:        The Pcd belongs to which file\r
    # @param BelongsToFunction:    The Pcd belongs to which function\r
    # @param StartLine:            StartLine of a Pcd\r
    # @param StartColumn:          StartColumn of a Pcd\r
    # @param EndLine:              EndLine of a Pcd\r
    # @param EndColumn:            EndColumn of a Pcd\r
    #\r
    def Create(self):\r
        SqlCommand = """create table IF NOT EXISTS %s (ID INTEGER PRIMARY KEY,\r
                                                       CName VARCHAR NOT NULL,\r
                                                       TokenSpaceGuidCName VARCHAR NOT NULL,\r
                                                       Token INTEGER,\r
                                                       DatumType VARCHAR,\r
                                                       Model INTEGER NOT NULL,\r
                                                       BelongsToFile SINGLE NOT NULL,\r
                                                       BelongsToFunction SINGLE DEFAULT -1,\r
                                                       StartLine INTEGER NOT NULL,\r
                                                       StartColumn INTEGER NOT NULL,\r
                                                       EndLine INTEGER NOT NULL,\r
                                                       EndColumn INTEGER NOT NULL\r
                                                      )""" % self.Table\r
        Table.Create(self, SqlCommand)\r
\r
    ## Insert table\r
    #\r
    # Insert a record into table Pcd\r
    #\r
    # @param ID:                   ID of a Pcd\r
    # @param CName:                CName of a Pcd\r
    # @param TokenSpaceGuidCName:  TokenSpaceGuidCName of a Pcd\r
    # @param Token:                Token of a Pcd\r
    # @param DatumType:            DatumType of a Pcd\r
    # @param Model:                Model of a Pcd\r
    # @param BelongsToFile:        The Pcd belongs to which file\r
    # @param BelongsToFunction:    The Pcd belongs to which function\r
    # @param StartLine:            StartLine of a Pcd\r
    # @param StartColumn:          StartColumn of a Pcd\r
    # @param EndLine:              EndLine of a Pcd\r
    # @param EndColumn:            EndColumn of a Pcd\r
    #\r
    def Insert(self, CName, TokenSpaceGuidCName, Token, DatumType, Model, BelongsToFile, BelongsToFunction, StartLine, StartColumn, EndLine, EndColumn):\r
        self.ID = self.ID + 1\r
        (CName, TokenSpaceGuidCName, DatumType) = ConvertToSqlString((CName, TokenSpaceGuidCName, DatumType))\r
        SqlCommand = """insert into %s values(%s, '%s', '%s', %s, '%s', %s, %s, %s, %s, %s, %s, %s)""" \\r
                                           % (self.Table, self.ID, CName, TokenSpaceGuidCName, Token, DatumType, Model, BelongsToFile, BelongsToFunction, StartLine, StartColumn, EndLine, EndColumn)\r
        Table.Insert(self, SqlCommand)\r
\r
        return self.ID