[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

libquran API proposal (was Re: al quraan)



maybe lets start it with libquran API design.
I propose following primitives for our library:

# quran_open_data 
  "opens data collection (text/mp3) from file"
  @param #1: char* (language: ar, en, id, fr, ... etc)
  @return: handle
  
# quran_read_verse
  "read a verse from opened data"
  @param #1: handle (from quran_open_data)
  @param #2: int (0: text, 1:mp3)
  @param #3: int (verse number)
  @return: pointer to verse

# quran_read_verses
  "read verses from opened data"
  @param #1: handle (from quran_open_data)
  @param #2: int (0: text, 1:mp3)
  @param #3: array of int (verses number)
  @return: array of pointers to verse

# quran_search
  "search string from opened data"
  @param #1: string(s)?
  @param #2: int (0: match all, 1: match any... etc)
  @return: array of int (verse number)

# quran_close_data
  "close opened data"
  @param #1: handle

# quran_verse_info
  @param #1: int (verse number)
  return: struct {
  		int juz_number;
  		int type (0: makiyyah, 1: madaniyyah);
		...etc info
	}

-- 
Mohammad DAMT <mdamt at mdamt dot com> http://www.mdamt.net
"biar kate disruduk kambing abang mati kaku, asal bisa idup ame nyai dasime", Nyai Dasime Kembang Pejambon, Benjamin S.