15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#!/usr/bin/env python 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# Copyright 2007 The Closure Linter Authors. All Rights Reserved. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# Licensed under the Apache License, Version 2.0 (the "License"); 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# you may not use this file except in compliance with the License. 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# You may obtain a copy of the License at 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# http://www.apache.org/licenses/LICENSE-2.0 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# Unless required by applicable law or agreed to in writing, software 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# distributed under the License is distributed on an "AS-IS" BASIS, 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# See the License for the specific language governing permissions and 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# limitations under the License. 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)"""Error object commonly used in linters.""" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)__author__ = ('robbyw@google.com (Robert Walker)', 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 'ajp@google.com (Andy Perelson)') 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Error(object): 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Object representing a style error.""" 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def __init__(self, code, message, token, position, fix_data): 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Initialize the error object. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Args: 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) code: The numeric error code. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) message: The error message string. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) token: The tokens.Token where the error occurred. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) position: The position of the error within the token. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) fix_data: Data to be used in autofixing. Codes with fix_data are: 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GOOG_REQUIRES_NOT_ALPHABETIZED - List of string value tokens that are 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class names in goog.requires calls. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self.code = code 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self.message = message 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self.token = token 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self.position = position 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if token: 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self.start_index = token.start_index 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) else: 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self.start_index = 0 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self.fix_data = fix_data 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if self.position: 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self.start_index += self.position.start 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def Compare(a, b): 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Compare two error objects, by source code order. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Args: 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) a: First error object. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) b: Second error object. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Returns: 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) A Negative/0/Positive number when a is before/the same as/after b. 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) line_diff = a.token.line_number - b.token.line_number 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if line_diff: 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return line_diff 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return a.start_index - b.start_index 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Compare = staticmethod(Compare) 66