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 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
|
// Copyright ©2013 The bíogo Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package fai implements FAI fasta sequence file index handling.
package fai
import (
"encoding/csv"
"errors"
"io"
"strconv"
)
const (
nameField = iota
lengthField
startField
basesField
bytesField
)
var ErrNonUnique = errors.New("non-unique record name")
// Index is an FAI index.
type Index map[string]Record
// Record is a single FAI index record.
type Record struct {
// Name is the name of the sequence.
Name string
// Length is the length of the sequence.
Length int
// Start is the starting seek offset of
// the sequence.
Start int64
// BasesPerLine is the number of sequences
// bases per line.
BasesPerLine int
// BytesPerLine is the number of bytes
// used to represent each line.
BytesPerLine int
}
// Position returns the seek offset of the sequence position p for the
// given Record.
func (r Record) Position(p int) int64 {
if p < 0 || r.Length <= p {
panic("fai: index out of range")
}
return r.position(p)
}
func (r Record) position(p int) int64 {
return r.Start + int64(p/r.BasesPerLine*r.BytesPerLine+p%r.BasesPerLine)
}
// endOfLineOffset returns the number of bytes until the end of the line
// holding position p.
func (r Record) endOfLineOffset(p int) int {
if p/r.BasesPerLine == r.Length/r.BasesPerLine {
return r.Length - p
}
return r.BasesPerLine - p%r.BasesPerLine
}
func mustAtoi(fields []string, index, line int) int {
i, err := strconv.ParseInt(fields[index], 10, 0)
if err != nil {
panic(parseError(line, index, err))
}
return int(i)
}
func mustAtoi64(fields []string, index, line int) int64 {
i, err := strconv.ParseInt(fields[index], 10, 64)
if err != nil {
panic(parseError(line, index, err))
}
return i
}
// ReadFrom returns an Index from the stream provided by an io.Reader or an error. If the input
// contains non-unique records the error is a csv.ParseError identifying the second non-unique
// record.
func ReadFrom(r io.Reader) (idx Index, err error) {
tr := csv.NewReader(r)
tr.Comma = '\t'
tr.FieldsPerRecord = 5
defer func() {
r := recover()
if r != nil {
e, ok := r.(error)
if !ok {
panic(r)
}
if _, ok = r.(*csv.ParseError); !ok {
panic(r)
}
err = e
idx = nil
}
}()
for line := 1; ; line++ {
rec, err := tr.Read()
if err == io.EOF {
return idx, nil
}
if err != nil {
return nil, err
}
if idx == nil {
idx = make(Index)
} else if _, exists := idx[rec[nameField]]; exists {
return nil, parseError(line, 0, ErrNonUnique)
}
idx[rec[nameField]] = Record{
Name: rec[nameField],
Length: mustAtoi(rec, lengthField, line),
Start: mustAtoi64(rec, startField, line),
BasesPerLine: mustAtoi(rec, basesField, line),
BytesPerLine: mustAtoi(rec, bytesField, line),
}
}
}
func parseError(line, column int, err error) *csv.ParseError {
return &csv.ParseError{
StartLine: line,
Line: line,
Column: column,
Err: err,
}
}
|