https://github.com/brenns10/dpath

EECS 433 Project - Directory Querying using XPath
https://github.com/brenns10/dpath

dpath file-system go xpath

Last synced: about 1 year ago
JSON representation

EECS 433 Project - Directory Querying using XPath

• Host: GitHub
• URL: https://github.com/brenns10/dpath
• Owner: brenns10
• Created: 2016-11-08T23:05:12.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-01-03T05:31:27.000Z (over 9 years ago)
• Last Synced: 2025-05-13T05:11:57.963Z (about 1 year ago)
• Topics: dpath, file-system, go, xpath
• Language: Go
• Size: 143 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.EECS433.md

Awesome Lists containing this project

README

          
Readme for EECS 433 Project Submission

======================================

This is the submission for Stephen Brennan's project, An XPath Query Evaluator

for Filesystems. The report PDF is located in the file:

    Brennan.Report.XPathFilesystem.pdf

You may build and run DPath on Mac or Linux with the following sequence of

commands:

-1. Install Go if not already installed: https://golang.org/dl/

0. `export GPATH=$HOME/go` if you do not have a Go environment set up

1. `go get` will install dependencies to your Go environment

2. `go build` will compile DPath. Executable will be simply named `dpath`

3. `go test` will run unit tests, if you care to run them

A pre-compiled version for 64 bit Linux is included in this submission as

`dpath.linux`. You need not have Go installed to use this binary.

Files

-----

The file `SYNTAX.md` describes all major features of DPath and gives basic usage

instructions. The file `GUIDE.md` contains a small guide to the code. Both of

these resources have some overlap with the information given in the paper.

The source code of DPath is provided in the following files:

    dpath.nex

    dpath.y

    tree.go

    item.go

    sequence.go

    axis.go

    lib.go

    util.go

    error.go

    main.go

Additionally, the following files contain tests for language constructs:

    eval_test.go

    lexer_test.go

    lib_test.go

    parser_test.go

    testutil.go

The following files are Go code which is *generated*:

- `dpath.nn.go` is a lexer generated from `dpath.nex`

    You are welcome to regenerate this file with the commands:

        go get github.com/blynn/nex

        $GOPATH/bin/nex dpath.nex

- `y.go` is a parser generated from `dpath.y`

    You are welcome to regenerate this file with the command:

        go tool yacc dpath.y

Simpler Setup

-------------

An easier way to run DPath is with:

    # if you don't have GOPATH set

    export GOPATH=$HOME/go

    go get github.com/brenns10/dpath

    # if you don't have $GOPATH/bin in your path

    export PATH=$GOPATH/bin

    dpath 'query'

However, this will download source files from GitHub rather than using those

files submitted in this ZIP archive.