lib-ruby-parser 3.0.5

Ruby parser
Documentation
use crate::nodes::InnerNode;
use crate::nodes::InspectVec;
use crate::Loc;
use crate::Node;

#[cfg(feature = "compile-with-external-structures")]
use crate::containers::ExternalMaybePtr;
#[cfg(feature = "compile-with-external-structures")]
type MaybePtr<T> = ExternalMaybePtr<T>;
#[cfg(not(feature = "compile-with-external-structures"))]
type MaybePtr<T> = Option<Box<T>>;


#[cfg(feature = "compile-with-external-structures")]
use crate::containers::ExternalPtr;
#[cfg(feature = "compile-with-external-structures")]
type Ptr<T> = ExternalPtr<T>;
#[cfg(not(feature = "compile-with-external-structures"))]
type Ptr<T> = Box<T>;


#[cfg(feature = "compile-with-external-structures")]
use crate::containers::ExternalMaybeLoc;
#[cfg(feature = "compile-with-external-structures")]
type MaybeLoc = ExternalMaybeLoc;
#[cfg(not(feature = "compile-with-external-structures"))]
type MaybeLoc = Option<Loc>;


/// Represents a class definition (using a `class` keyword, `Class.new` is just a method call)
///
#[derive(Debug, Clone, PartialEq)]
#[repr(C)]
pub struct Class {
    /// Name of the class, `String("Foo")` for `class Foo; end`
    ///
    pub name: Ptr<Node>,
    /// Superclass. Can be an expression in cases like `class A < (obj.foo + 1); end`
    ///
    /// `None` if no explicit superclass given (i.e. `class Foo; end`)
    ///
    pub superclass: MaybePtr<Node>,
    /// Body of the method, `None` if there's no body.
    ///
    pub body: MaybePtr<Node>,
    /// Location of the `class` keyword.
    ///
    /// ```text
    /// class Foo; end
    /// ~~~~~
    /// ```
    ///
    pub keyword_l: Loc,
    /// Location of the `<` operator
    ///
    /// ```text
    /// class A < B; end
    ///         ~
    /// ```
    ///
    /// `None` if there's no explicit superclass given.
    ///
    pub operator_l: MaybeLoc,
    /// Location of the `end` keyword.
    ///
    /// ```text
    /// class Foo; end
    ///            ~~~
    /// ```
    ///
    pub end_l: Loc,
    /// Location of the full expression
    ///
    /// ```text
    /// class Foo; end
    /// ~~~~~~~~~~~~~~
    /// ```
    ///
    pub expression_l: Loc,
}

impl InnerNode for Class {
    fn expression(&self) -> &Loc {
        &self.expression_l
    }

    fn inspected_children(&self, indent: usize) -> Vec<String> {
        let mut result = InspectVec::new(indent);
        result.push_node(&self.name);
        result.push_maybe_node_or_nil(&self.superclass);
        result.push_maybe_node_or_nil(&self.body);
        result.strings()
    }

    fn str_type(&self) -> &'static str {
        "class"
    }

    fn print_with_locs(&self) {
        println!("{}", self.inspect(0));
        self.name.inner_ref().print_with_locs();
        self.superclass.as_ref().map(|node| node.inner_ref().print_with_locs());
        self.body.as_ref().map(|node| node.inner_ref().print_with_locs());
        self.keyword_l.print("keyword");
        self.operator_l.as_ref().map(|loc| loc.print("operator"));
        self.end_l.print("end");
        self.expression_l.print("expression");
    }
}