spidior 0.2.1

A tool for handling sed-like substitution tasks where pesky source code semantics are getting in the way.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

//! This module is for language specific implementations of the traits in the
//! `parsing` module. These traits are separated out as not all languages
//! have the same features to be extracted. For example,
//! Python has Function names to be extracted, but as its
//! identifiers do not have statically knowable types, it
//! is not Identifiers.
//! C and Java on the other hand have both extractable Functions
//! and Identifiers.

/// Provides traits for parsing different features of source code
pub mod parsing {
    use serde::{Deserialize, Serialize};

    #[derive(Serialize, Deserialize)]
    pub struct Info {
        pub filename: String,
        pub functions: Vec<Function>,
        pub identifiers: Vec<Identifier>,
    }

    impl Info {
        pub fn new(
            filename: String,
            functions: Vec<Function>,
            identifiers: Vec<Identifier>,
        ) -> Self {
            Self {
                filename,
                functions,
                identifiers,
            }
        }
    }

    /// Represents a function in a source code file
    #[derive(Serialize, Deserialize, Debug)]
    pub struct Function {
        /// We only care about named functions - thus, all functions have names
        pub name: String,
        /// The start position of the function
        pub start: usize,
        /// The end position of the function
        pub end: usize,
    }

    /// Represents an identifier in a piece of code, which has an associated type
    #[derive(Serialize, Deserialize, Debug)]
    pub struct Identifier {
        /// The name of the identifier, which is the set of characters used to refer to it
        pub name: String,
        /// The type of value the identifier represents
        pub type_name: String,
        /// The starting index within the source file this identifier is located at
        pub start: usize,
        /// The index one past the end of the identifier's location
        pub end: usize,
    }

    /// A trait for language processors that support named functions
    pub trait Functions {
        /// Retrieves a vector of all the named functions given a piece of source code
        /// # Arguments
        ///
        /// * `text` - A string slice that contains the source code to be analyzed
        ///
        /// # Returns
        ///
        /// A `Vec<Function>` containing every named function within `text`
        fn read_functions(&self, text: &str) -> Vec<Function>;
    }

    /// A trait for language processors that support tracking identifiers
    pub trait Identifiers {
        /// Retrieves a vector of all the typed identifiers within a piece of source code
        /// # Arguments
        ///
        /// * `text` - A string slice that contains the source code to be analyzed
        ///
        /// A `Vec<Identifier>` containing every named identifier within `text`
        fn read_identifiers(&self, text: &str) -> Vec<Identifier>;
    }

    impl Identifier {
        /// Creates a new Identifier given a set of parameters
        /// # Arguments
        ///
        /// * `text` - A String that contains the name of the identifier
        /// * `typ` - A String that contains the name of the type of the identifier
        /// * `start` - a number representing the where the identifier starts in the code
        /// * `end` - a number representing the where the identifier ends in the code
        ///
        pub fn new(name: String, typ: String, start: usize, end: usize) -> Self {
            Self {
                name,
                type_name: typ,
                start,
                end,
            }
        }
    }

    impl Function {
        /// Creates a new Function given a set of parameters
        /// # Arguments
        ///
        /// * `text` - A String that contains the name of the function
        ///
        pub fn new(name: String, start: usize, end: usize) -> Self {
            Self { name, start, end }
        }
    }
}
pub mod clike;
pub mod rustlike;