scripts/pdn/src/PdnPinDumper/src/frDesign.h

/* Authors: Lutong Wang and Bangqi Xu */
/*
 * Copyright (c) 2019, The Regents of the University of California
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the University nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _FR_DESIGN_H_
#define _FR_DESIGN_H_

#include <memory>
#include "global.h"
#include "frBaseTypes.h"
#include "db/obj/frBlock.h"
#include "db/tech/frTechObject.h"
#include "frRegionQuery.h"

namespace fr {
  namespace io {
    class Parser;
  }
  class frDesign {
  public:
    // constructors
    frDesign(): topBlock(nullptr), tech(std::make_unique<frTechObject>()), 
                rq(std::make_unique<frRegionQuery>(this)) {}
    // getters
    frBlock* getTopBlock() const {
      return topBlock.get();
    }
    frTechObject* getTech() const {
      return tech.get();
    }
    frRegionQuery* getRegionQuery() const {
      return rq.get();
    }
    std::vector<std::unique_ptr<frBlock> >& getRefBlocks() {
      return refBlocks;
    }
    const std::vector<std::unique_ptr<frBlock> >& getRefBlocks() const {
      return refBlocks;
    }
    // setters
    void setTopBlock(std::unique_ptr<frBlock> &in) {
      topBlock = std::move(in);
    }
    void addRefBlock(std::unique_ptr<frBlock> &in) {
      name2refBlock[in->getName()] = in.get();
      refBlocks.push_back(std::move(in));
    }
    // others
    void printAllMacros();
    void printAllComps();
    void printAllTerms();
    void printCMap();
    friend class io::Parser;
  protected:
    std::unique_ptr<frBlock>                      topBlock;
    std::map<frString, frBlock*>                  name2refBlock;
    std::vector<std::unique_ptr<frBlock> >        refBlocks;
    std::unique_ptr<frTechObject>                 tech;
    std::unique_ptr<frRegionQuery>                rq;
  };
}

#endif