skydoc/stubs/attr.py

# Copyright 2016 The Bazel Authors. All rights reserved.
#
# 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.

from src.main.protobuf import build_pb2

def strcmp(s1, s2):
  if s1 > s2:
    return 1
  elif s1 < s2:
    return -1
  else:
    return 0

def attr_compare(a, b):
  if a.compare_priority() > b.compare_priority():
    return 1
  elif a.compare_priority() < b.compare_priority():
    return -1
  else:
    return strcmp(a.name, b.name)

class AttrDescriptor(object):
  ATTRIBUTE_ORDERING = {
      "name": -99,
      "deps": -98,
      "src": -97,
      "srcs": -86,
      "data": -95,
      "resource": -94,
      "resources": -93,
      "out": -92,
      "outs": -91,
      "hdrs": -90,
  }

  def __init__(self, type=build_pb2.Attribute.UNKNOWN, default=None,
               mandatory=False, doc="", name=""):
    """Constructor for AttrDescriptor

    Args:
      self: The current instance
      type: The type of attribute based on the enum in the Attribute proto.
      default: The default value of the attribute.
      mandatory: True if the attribute is required, false if optional.
      doc: Documentation for this attribute. This parameter is used internally
        by skydoc and is not set by any Skylark code in .bzl files.
      name: Name of this attribute. This parameter is used internally by skydoc
        and is not set by any Skylark code in .bzl files.
    """
    self.type = type
    self.default = default
    self.mandatory = mandatory
    self.doc = doc
    self.name = name

  def compare_priority(self):
    if self.name in AttrDescriptor.ATTRIBUTE_ORDERING:
      return AttrDescriptor.ATTRIBUTE_ORDERING[self.name]
    else:
      return 0

def bool(default=False, mandatory=False):
  return AttrDescriptor(build_pb2.Attribute.BOOLEAN, default=default,
                        mandatory=mandatory)

def int(default=0, mandatory=False, values=[]):
  return AttrDescriptor(build_pb2.Attribute.INTEGER, default, mandatory)

def int_list(default=[], mandatory=False, non_empty=False):
  return AttrDescriptor(build_pb2.Attribute.INTEGER_LIST, default, mandatory)

def label(default=None, executable=False, allow_files=False, mandatory=False,
    providers=[], allow_rules=None, single_file=False, cfg=None):
  return AttrDescriptor(build_pb2.Attribute.LABEL, default, mandatory)

def label_list(default=[], allow_files=False, allow_rules=None, providers=[],
               flags=[], mandatory=False, non_empty=False, cfg=None,
               aspects=[]):
  return AttrDescriptor(build_pb2.Attribute.LABEL_LIST, default, mandatory)

def license(default=None, mandatory=False):
  return AttrDescriptor(build_pb2.Attribute.LICENSE, default, mandatory)

def output(default=None, mandatory=False):
  return AttrDescriptor(build_pb2.Attribute.OUTPUT, default, mandatory)

def output_list(default=[], mandatory=False, non_empty=False):
  return AttrDescriptor(build_pb2.Attribute.OUTPUT_LIST, default, mandatory)

def string(default='', mandatory=False, values=[]):
  return AttrDescriptor(build_pb2.Attribute.STRING, default, mandatory)

def string_dict(default={}, mandatory=False, non_empty=False):
  return AttrDescriptor(build_pb2.Attribute.STRING_DICT, default, mandatory)

def string_list(default=[], mandatory=False, non_empty=False):
  return AttrDescriptor(build_pb2.Attribute.STRING_LIST, default, mandatory)

def string_list_dict(default={}, mandatory=False, non_empty=False):
  return AttrDescriptor(build_pb2.Attribute.STRING_LIST_DICT, default,
                        mandatory)