tame/tamer/src/asg/graph/object/pkg.rs

100 lines
2.5 KiB
Rust
Raw Normal View History

// Packages represented on ASG
//
// Copyright (C) 2014-2023 Ryan Specialty, LLC.
//
// This file is part of TAME.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//! Package object on the ASG.
use std::fmt::Display;
use crate::{asg::Asg, span::Span};
use super::{
Ident, Object, ObjectIndex, ObjectKind, ObjectRel, ObjectRelTy,
ObjectRelatable,
};
#[derive(Debug, PartialEq, Eq)]
pub struct Pkg(Span);
impl Pkg {
pub fn new<S: Into<Span>>(span: S) -> Self {
Self(span.into())
}
pub fn span(&self) -> Span {
match self {
Self(span) => *span,
}
}
}
impl Display for Pkg {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "package")
}
}
/// Subset of [`ObjectKind`]s that are valid targets for edges from
/// [`Ident`].
///
/// See [`ObjectRel`] for more information.
#[derive(Debug, PartialEq, Eq)]
pub enum PkgRel {
Ident(ObjectIndex<Ident>),
}
impl ObjectRel for PkgRel {
fn narrow<OB: ObjectKind + ObjectRelatable>(
self,
) -> Option<ObjectIndex<OB>> {
match self {
Self::Ident(oi) => oi.filter_rel(),
}
}
}
impl ObjectRelatable for Pkg {
type Rel = PkgRel;
fn rel_ty() -> ObjectRelTy {
ObjectRelTy::Pkg
}
fn new_rel_dyn(ty: ObjectRelTy, oi: ObjectIndex<Object>) -> Option<PkgRel> {
match ty {
ObjectRelTy::Root => None,
ObjectRelTy::Ident => Some(PkgRel::Ident(oi.must_narrow_into())),
ObjectRelTy::Expr => None,
ObjectRelTy::Pkg => None,
}
}
}
impl From<ObjectIndex<Ident>> for PkgRel {
fn from(value: ObjectIndex<Ident>) -> Self {
Self::Ident(value)
}
}
impl ObjectIndex<Pkg> {
/// Indicate that the given identifier `oi` is defined in this package.
pub fn defines(&self, asg: &mut Asg, oi: ObjectIndex<Ident>) -> Self {
self.add_edge_to(asg, oi)
}
}