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
// Copyright 2016 Kyle Mayes
//
// 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.
//! Lexed pieces of source files.
use std::fmt;
use std::mem;
use clang_sys::*;
use utility;
use super::{TranslationUnit};
use super::source::{SourceLocation, SourceRange};
//================================================
// Enums
//================================================
// TokenKind _____________________________________
/// Indicates the categorization of a token.
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
#[repr(C)]
pub enum TokenKind {
/// A comment token.
Comment = 4,
/// An identifier token.
Identifier = 2,
/// A keyword token.
Keyword = 1,
/// A literal token.
Literal = 3,
/// A puncuation token.
Punctuation = 0,
}
//================================================
// Structs
//================================================
// Token _________________________________________
/// A lexed piece of a source file.
#[derive(Copy, Clone)]
pub struct Token<'tu> {
pub(crate) raw: CXToken,
tu: &'tu TranslationUnit<'tu>,
}
impl<'tu> Token<'tu> {
//- Constructors -----------------------------
#[doc(hidden)]
pub fn from_raw(raw: CXToken, tu: &'tu TranslationUnit<'tu>) -> Token<'tu> {
Token{ raw, tu }
}
//- Accessors --------------------------------
/// Returns the categorization of this token.
pub fn get_kind(&self) -> TokenKind {
unsafe { mem::transmute(clang_getTokenKind(self.raw)) }
}
/// Returns the textual representation of this token.
pub fn get_spelling(&self) -> String {
unsafe { utility::to_string(clang_getTokenSpelling(self.tu.ptr, self.raw)) }
}
/// Returns the source location of this token.
pub fn get_location(&self) -> SourceLocation<'tu> {
unsafe { SourceLocation::from_raw(clang_getTokenLocation(self.tu.ptr, self.raw), self.tu) }
}
/// Returns the source range of this token.
pub fn get_range(&self) -> SourceRange<'tu> {
unsafe { SourceRange::from_raw(clang_getTokenExtent(self.tu.ptr, self.raw), self.tu) }
}
}
impl<'tu> fmt::Debug for Token<'tu> {
fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
formatter.debug_struct("Token")
.field("kind", &self.get_kind())
.field("spelling", &self.get_spelling())
.field("range", &self.get_range())
.finish()
}
}